Batch Provision Cloud Phone Users via CreateUsers API - Cloud Phone - Alibaba Cloud - Cloud Phone

Create accounts for end users.

Operation description

A convenience account is an account system for Wuying Workspace, ideal for simple scenarios that do not require Enterprise Active Directory integration. A convenience account includes a username and an email. Both are required.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:CreateUsers

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Users	array<object>	Yes	Information about the convenience accounts.	CreateUsers
	object	No	Information about a convenience account.
EndUserId	string	Yes	The username. It must be 3 to 24 characters long and can contain only lowercase letters, digits, and underscores (_).	alice
Email	string	No	The user's email address. This address is used to receive notifications, such as those for cloud desktop assignments. You must specify either this parameter or `Phone`.	username@example.com
Phone	string	No	The international site does not support this feature.	1381111****
Password	string	No	The user's password. Note The password must be at least 10 characters long and must contain at least three of the following character types: uppercase letters, lowercase letters, numbers, and special characters (excluding spaces).	Wuying1234
OwnerType	string	No	The account activation type. Valid values: CreateFromManager : Administrator activation Normal : User activation	Normal
OrgId	string	No	The ID of the user's organization.	design
Remark	string	No	A remark about the user.	remark1
RealNickName	string	No	The user's display name.	Bean
GroupIdList	array	No
	string	No
Password	string	No	The initial password. If you do not specify this parameter, a password reset email is sent to the user.	Test123****
AutoLockTime	string	No	The date and time to automatically lock the account. The time must be in `yyyy-MM-dd HH:mm:ss` format.	2025-11-28 00:00:00
IsLocalAdmin	boolean	No	Specifies whether to grant the convenience account local administrator privileges.	true
PasswordExpireDays	string	No	By default, a convenience account's password does not expire. You can use this parameter to specify a password validity period of 30 to 365 days. When the password expires, the user must change it before logging on to the cloud desktop. Note This feature is in invitation-only preview. To use this feature, submit a ticket.	30
BusinessChannel	string	No	The channel.	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResult	object	The result of the operation to create convenience users.
CreatedUsers	array<object>	Details of successfully created convenience users.
	object	Details of a successfully created convenience user.
EndUserId	string	The username.	test1
Email	string	The email address.	username@example.com
Phone	string	The phone number.	1381111****
Remark	string	The remarks for the user.	remark1
RealNickName	string	The user's display name.	Bean
FailedUsers	array<object>	Details of convenience users whose creation failed.
	object	Details of a convenience user whose creation failed.
EndUserId	string	The username.	test2
Email	string	The email address.	username2@example.com
Phone	string	The phone number.	1390000****
ErrorCode	string	The error code.	ExistedEndUserId
ErrorMessage	string	The error message.	The username test is used by another user.
AllSucceed	boolean	Indicates whether the creation of all convenience users succeeded. A value of `true` means all users were created, while a value of `false` means the creation of one or more users failed.

Examples

Success response

JSON format

{
  "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."
      }
    ]
  },
  "AllSucceed": false
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.