调用CreateUsers创建一个或者多个便捷用户。

接口说明

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateUsers

系统规定参数。取值:CreateUsers

Password String Test123****

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

Users.N.EndUserId String test1

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

Users.N.Email String test1@example***.com

邮箱。用于接收相关邮件,如分配桌面通知邮件。

Users.N.Phone String 1871234****

手机号。

返回数据

名称 类型 示例值 描述
RequestId String F7475910-CB38-4994-9EC4-5B8893FF0AA6

请求ID。

CreateResult Object

创建便捷用户操作的结果。

CreatedUsers Array of createdUsers

创建成功的便捷用户信息。

EndUserId String test1

用户名。

Email String test1@example***.com

邮箱。

Phone String 1871234****

手机号。

FailedUsers Array of failedUsers

创建失败的便捷用户信息。

EndUserId String test2

用户名。

Email String test2@example***.com

邮箱。

Phone String 1871234****

手机号。

ErrorCode String ExistedEndUserId

错误码。

ErrorMessage String username test is used by other user

错误信息。

示例

请求示例

https://eds-user.cn-shanghai.aliyuncs.com/?Action=CreateUsers
&Users.1.Email=test1
&Users.1.EndUserId=test1@example***.com
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateUsersResponse>
    <RequestId>C048E8AB-1084-5017-8355-0B5FBF10CE99</RequestId>
    <CreateResult>
        <CreatedUsers>
            <EndUserId>test1</EndUserId>
            <Email>test1@example***.com</Email>
            <Phone>1871234****</Phone>
        </CreatedUsers>
    </CreateResult>
</CreateUsersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C048E8AB-1084-5017-8355-0B5FBF10CE99",
  "CreateResult" : {
    "FailedUsers" : [ ],
    "CreatedUsers" : [ {
      "EndUserId" : "test1",
      "Email" : "test1@example***.com",
      "Phone" : "1871234****"
    } ]
  }
}