文档

CreateUsers - 创建便捷账号

为终端用户创建便捷账号。

接口说明

便捷账号是无影专用的账号体系,适用于不希望对接企业 AD 的简单场景。便捷账号信息包括用户名、邮箱和手机号。其中,用户名为必填信息,邮箱和手机号至少填写一项。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Usersobject []

便捷账号信息。

CreateUsers
EndUserIdstring

用户名。自定义设置,由小写字母、数字和下划线组成,长度为 3~24 个字符。

alice
Emailstring

邮箱。用于接收相关邮件,如分配云电脑的通知邮件。邮箱和手机号二选一必填。

username@example.com
Phonestring

手机号。用于接收相关短信,如分配云电脑的通知短信。邮箱和手机号二选一必填。

1381111****
Passwordstring

用户密码。

说明 密码长度不少于 10 位,且至少包含大写字母、小写字母、数字、特殊字符(除空格)中的任意三种。
Wuying1234
OwnerTypestring

账号激活类型。

枚举值:
  • CreateFromManager管理员激活
  • Normal用户激活
Normal
OrgIdstring

用户所属的组织。

design
Remarkstring

用户备注。

remark1
RealNickNamestring

用户的显示名。

Bean
Passwordstring

初始密码。如果不设置,将发送重置密码邮件到用户邮箱。

Test123****
AutoLockTimestring

自动锁定账号的日期。

2023-03-03
IsLocalAdminboolean

是否将该便捷账号设为本地管理员。

true
PasswordExpireDaysstring

用户账号的密码默认为永久有效,可通过此参数设置 30~365 天的密码有效期,当密码到期后,终端用户必须先修改密码才能继续登录。

说明 该功能目前处于邀测中,如需体验,请提交工单申请开通。
30

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResultobject

创建便捷账号操作的结果。

CreatedUsersobject []

创建成功的便捷账号信息。

EndUserIdstring

用户名。

test1
Emailstring

邮箱。

username@example.com
Phonestring

手机号。

1381111****
Remarkstring

用户备注。

remark1
RealNickNamestring

用户的显示名。

Bean
FailedUsersobject []

创建失败的便捷账号信息。

EndUserIdstring

用户名。

test2
Emailstring

邮箱。

username2@example.com
Phonestring

手机号。

1390000****
ErrorCodestring

错误码。

ExistedEndUserId
ErrorMessagestring

错误信息。

The username test is used by another user.

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "CreateResult": {
    "CreatedUsers": [
      {
        "EndUserId": "test1",
        "Email": "username@example.com",
        "Phone": "1381111****",
        "Remark": "remark1",
        "RealNickName": "Bean"
      }
    ],
    "FailedUsers": [
      {
        "EndUserId": "test2",
        "Email": "username2@example.com",
        "Phone": "1390000****",
        "ErrorCode": "ExistedEndUserId",
        "ErrorMessage": "The username test is used by another user."
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400INTERNAL_ERRORInternal error.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:IsLocalAdmin
    新增入参:PasswordExpireDays
2024-01-16OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-08-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:AutoLockTime
2021-04-02新增 OpenAPI看变更集
  • 本页导读 (0)