Creates one or more convenience users.

Description

Convenience users are dedicated Elastic Desktop Service (EDS) user accounts. These accounts are suitable for scenarios in which you do not need to connect to enterprise AD systems.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateUsers

The operation that you want to perform. Set the value to CreateUsers.

Users.N.Email String Yes test1

The email address of user N. You can specify email addresses for multiple users. The EDS system sends emails such as password reset emails to the email address.

Users.N.EndUserId String Yes test1@example***.com

Username of user N. You can specify multiple usernames. The username can contain lowercase letters, digits, and underscores (_), and must be 3 to 24 characters in length.

Password String No Test123****

The initial password. If you leave this parameter empty, a password reset email is sent to the email address that you specify.

Users.N.Phone String No 1871234****

The mobile phone number.

Response parameters

Parameter Type Example Description
CreateResult Struct

The result of the operation.

CreatedUsers Array of createdUsers

The information about the convenience users that were created.

Email String test1@example***.com

The email address of the user.

EndUserId String test1

The username of the user.

Phone String 1871234****

The mobile phone number.

FailedUsers Array of failedUsers

The information about the convenience users that fails to be created.

Email String test2@example***.com

The email address.

EndUserId String test2

The username of the user.

ErrorCode String ExistedEndUserId

The error code.

ErrorMessage String username test is used by other user

The error message.

Phone String 1871234****

The mobile phone number.

RequestId String F7475910-CB38-4994-9EC4-5B8893FF0AA6

The ID of the request.

Examples

Sample requests

https://eds-user.cn-shanghai.aliyuncs.com/?Action=CreateUsers
&Users.1.Email=test1
&Users.1.EndUserId=test1@example***.com
&<Common request parameters>

Sample success responses

XML format

<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 format

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