CreateUsers-阿里云帮助中心

Creates a convenience account for an end user.

Operation description

A convenience account is an account system dedicated to Wuying Workspace and is suitable for simple scenarios where you do not want to connect to an enterprise Active Directory (AD). The information of a convenience account includes the username, email address, and mobile phone number. The username is required, and you must specify at least one of the email address and mobile phone number.

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	The convenience account information.	CreateUsers
	object	No	The convenience account information.
EndUserId	string	Yes	The username. The username is custom and must be 3 to 24 characters in length. It can contain only lowercase letters, digits, and underscores.	alice
Email	string	No	The email address. It is used to receive relevant emails, such as notification emails for cloud computer allocation. You must specify either the email address or the mobile phone number.	username@example.com
Phone	string	No	The mobile phone number. The mobile phone number is used to receive relevant text messages, such as notification text messages for cloud computer allocation. You must specify either the email address or the mobile phone number.	1381111****
Password	string	No	The user password. Note The password must be at least 10 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (excluding spaces).	Wuying1234
OwnerType	string	No	The account activation type. Valid values: CreateFromManager : Activated by the administrator. Normal : Activated by the user.	Normal
OrgId	string	No	The organization to which the user belongs.	design
Remark	string	No	The remarks for the user.	remark1
RealNickName	string	No	The display name of the user.	Bean
GroupIdList	array	No	The IDs of the user groups to join.
	string	No	The user group ID.	ug-2412ojkwtybd****
Password	string	No	The initial password. If you do not specify this parameter, a password reset email is sent to the user's email address.	Test123****
AutoLockTime	string	No	The date when the account is automatically locked. Specify the date in the yyyy-MM-dd HH:mm:ss format.	2025-11-28 00:00:00
IsLocalAdmin	boolean	No	Specifies whether to set the convenience account as a local administrator.	true
PasswordExpireDays	string	No	The validity period of the password for the user account. By default, the password never expires. You can set this parameter to a value from 30 to 365 to specify the validity period in days. After the password expires, the end user must change the password before logging on. Note This feature is in invitational preview. To use this feature, submit a ticket.	30
BusinessChannel	string	No	The channel.	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The returned information.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResult	object	The result of the convenience account creation operation.
CreatedUsers	array<object>	The information about the convenience accounts that were created.
	object	The information about the convenience accounts that were created.
EndUserId	string	The username.	test1
Email	string	The email address.	username@example.com
Phone	string	The mobile phone number.	1381111****
Remark	string	The remarks for the user.	remark1
RealNickName	string	The display name of the user.	Bean
FailedUsers	array<object>	The information about the convenience accounts that failed to be created.
	object	The information about the convenience accounts that failed to be created.
EndUserId	string	The username.	test2
Email	string	The email address.	username2@example.com
Phone	string	The mobile 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 all convenience accounts were created.

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.