CreateUsers-阿里云帮助中心

Easily create accounts for your end users.

Operation description

A convenience account is a dedicated account system in Wuying Workspace for simple use cases that do not require enterprise AD integration. Accounts require a username, and either an email or a 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	Details about the convenience users.	CreateUsers
	object	No	Details about the convenience user.
EndUserId	string	Yes	The user name. The user name must be 3 to 24 characters long and can contain lowercase letters, digits, and underscores (_).	alice
Email	string	No	The email address of the convenience user. This email address is used for notifications, such as an alert when a cloud computer is assigned. You must specify either this parameter or the `Phone` parameter.	username@example.com
Phone	string	No	The phone number of the convenience user. This phone number is used for notifications, such as a text message when a cloud computer is assigned. You must specify either this parameter or the `Email` parameter.	1381111****
Password	string	No	The password for the convenience user. Note The password must be at least 10 characters long and contain characters from 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 : Administrator activation Normal : User activation	Normal
OrgId	string	No	The ID of the organization to which the convenience user belongs.	design
Remark	string	No	A remark for the convenience user.	remark1
RealNickName	string	No	The display name of the convenience user.	Bean
GroupIdList	array	No
	string	No
Password	string	No	The initial password. If you do not specify this parameter, the system sends a password reset email to the convenience user's email address.	Test123****
AutoLockTime	string	No	The date and time when the system automatically locks the convenience user's account. The value must be in the `yyyy-MM-dd HH:mm:ss` format.	2025-11-28 00:00:00
IsLocalAdmin	boolean	No	Specifies whether to set the convenience user as a local administrator.	true
PasswordExpireDays	string	No	By default, a convenience user's password does not expire. You can use this parameter to specify a password validity period of 30 to 365 days. After the password expires, the user must reset it to log in again. Note This feature is in invited preview. To use this feature, submit a ticket.	30
BusinessChannel	string	No	The business channel.	ENTERPRISE

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
CreateResult	object	The result of creating convenience accounts.
CreatedUsers	array<object>	The convenience accounts that were successfully created.
	object	A convenience account that was successfully created.
EndUserId	string	The user name.	test1
Email	string	The email address.	username@example.com
Phone	string	The phone number.	1381111****
Remark	string	The user's remark.	remark1
RealNickName	string	The display name.	Bean
FailedUsers	array<object>	The convenience accounts that failed to be created.
	object	A convenience account that failed to be created.
EndUserId	string	The user name.	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

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.