CreateUser - Identity as a Service - Alibaba Cloud Documentation Center

Creates an EIAM account in the specified EIAM instance.

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

eiam:CreateUser

create

*User

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
Username	string	Yes	The name of the account. The name can contain letters, digits, and the following special characters: _ . @ -. The name can be up to 128 characters long.	user_001
DisplayName	string	No	The display name of the account. The display name can be up to 128 characters long.	name_001
Password	string	No	The password. For more information about the format requirements, see Password policy.	123456
PhoneRegion	string	No	The area code for the mobile phone number. The area code must be 1 to 6 digits in length and cannot contain the plus sign (+).	86
PhoneNumber	string	No	The mobile phone number. The mobile phone number must be 6 to 15 digits in length.	12345678901
PhoneNumberVerified	boolean	No	Specifies whether the mobile phone number is verified. A verified number is considered trusted. This parameter is required if you specify a mobile phone number. For most scenarios, set this to true.	true
Email	string	No	The email address. The prefix of the email address can contain uppercase letters, lowercase letters, digits, periods (.), underscores (_), and hyphens (-). The email address can be up to 128 characters long.	example@example.com
EmailVerified	boolean	No	Specifies whether the email address is verified. A verified email address is considered trusted. This parameter is required if you specify an email address. For most scenarios, set this to true.	true
UserExternalId	string	No	The external ID of the account. This ID is used to associate the account with an external system. The external ID can be up to 128 characters long. If you do not set this parameter, the value of the account ID is used by default.	user_d6sbsuumeta4h66ec3il7yxxxx
PrimaryOrganizationalUnitId	string	Yes	The ID of the primary organizational unit.	ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitIds	array	No	The list of IDs of the secondary organizational units. An account can belong to multiple organizational units.
	string	No	The ID of the organizational unit.	ou_adz2vmgiwpo4tu6jtss3mynjji
Description	string	No	The description. The description can be up to 256 characters long.	description text
CustomFields	array<object>	No	The list of custom fields.	description
	object	No	The custom field object.
FieldName	string	No	The name of the custom field. Create the custom field in the console before using it. For more information, see the Custom Fields module.	age
FieldValue	string	No	The value of the custom field. The value must comply with the limits on the properties of the custom field.	10
PasswordInitializationConfig	object	No	The password initialization configurations.
PasswordInitializationPolicyPriority	string	No	The priority of the password initialization policy. This parameter is disabled by default. Valid values: global: The instance-level password initialization policy is used. The settings in this request are ignored. For more information, see the password initialization policy in Password policies. custom: The password initialization policy specified in this request is used. This includes the forced password reset status, the initialization method, and the notification channels.	global
PasswordForcedUpdateStatus	string	No	The status of forced password reset. This parameter is disabled by default. Valid values: enabled: Enabled. disabled: Disabled.	enabled
UserNotificationChannels	array	No	The list of notification channels for the password.	sms
	string	No	The notification channel for the password. Valid values: email: email sms: text message	sms
PasswordInitializationType	string	No	The password initialization method. Valid values: random: random	random
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. Use the client to generate a token. Ensure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	client-token-example

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
UserId	string	The account ID.	user_d6sbsuumeta4h66ec3il7yxxxx

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "UserId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

Error codes

HTTP status code	Error code	Error message	Description
403	ResourceDuplicated.Username	The specified resource: Username already exist.	Duplicate user name

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.