CreateUsers - Elastic Desktop Service - Alibaba Cloud Documentation Center

Creates a convenience user.

Operation description

Convenience users are dedicated Elastic Desktop Service (EDS) user accounts and are suitable for scenarios in which you do not need to connect to enterprise Active Directory (AD) systems. The information about a convenience user includes the username, email address, and mobile number. You must specify the username or email address.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Users	object []	Yes	The information about the convenience user.	CreateUsers
EndUserId	string	Yes	The username of the convenience user. The name can contain lowercase letters, digits, and underscores (_), and must be 3 to 24 characters in length.	test1
Email	string	No	The email address of the convenience user. The email address is used to receive notifications about events such as desktop assignment. You must specify an email address or a mobile number to receive notifications.	username@example.com
Phone	string	No	Mobile numbers are not supported on the international site (alibabacloud.com).	1381111****
Password	string	No	The user password. Note The password must be at least 10 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (excluding spaces).	password1
OwnerType	string	No	The type of the account ownership. Valid values: CreateFromManager: administrator-activated Normal: user-activated	Normal
OrgId	string	No	The organization to which the convenience user belongs.	1111****
Remark	string	No	The remarks on the convenience user.	remark1
RealNickName	string	No	The display name of the end user.	Bean
Password	string	No	The initial password. If this parameter is left empty, an email for password reset is sent to the specified email address.	Test123****
AutoLockTime	string	No	The date on which the convenience users are automatically locked.	2023-03-03

Response parameters

Parameter	Type	Description	Example
	object	The information that is returned.
RequestId	string	The ID of the request.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResult	object	The result of user creation.
CreatedUsers	object []	Details of the created convenience users.
EndUserId	string	The name of the end user.	test1
Email	string	The email address of the end user.	username@example.com
Phone	string	The mobile number of the end user.	1381111****
Remark	string	The remarks of the end user.	remark1
RealNickName	string	The display name of the end user.	Bean
FailedUsers	object []	Details of the convenience users that failed to be created.
EndUserId	string	The name of the end user.	test2
Email	string	The email address of the end user.	username2@example.com
Phone	string	The mobile number of the end user.	1390000****
ErrorCode	string	The error code returned if the request failed.	ExistedEndUserId
ErrorMessage	string	The error message returned.	The username test is used by another user.

Examples

Sample success responses

JSONformat

{
  "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."
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	INTERNAL_ERROR	Internal error.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-04-09

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: IsLocalAdmin
	Added Input Parameters: PasswordExpireDays

2024-01-16

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Output Parameters	The response structure of the API has changed.

2023-08-31

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: AutoLockTime

2021-04-02

Add Operation

see changesets