Create a RAM user by calling the CreateUser API - Resource Access Management - Alibaba Cloud - Resource Access Management

Creates a RAM user.

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

ram:CreateUser

create

*User

acs:ram::{#accountId}:user/*

None

Request parameters

Parameter	Type	Required	Description	Example
UserPrincipalName	string	Yes	The logon name of the Resource Access Management (RAM) user. The name is in the format of `<username>@<AccountAlias>.onaliyun.com`. `<username>` indicates the name of the RAM user. `<AccountAlias>.onaliyun.com` indicates the default domain name. For more information about how to query the default domain name, see GetDefaultDomain. The value of `UserPrincipalName` must be `1 to 128` characters in length and can contain letters, digits, periods (.), hyphens (-), and underscores (_). The value of `<username>` must be `1 to 64` characters in length.	Test@example.onaliyun.com
DisplayName	string	Yes	The display name of the RAM user. The name must be 1 to 24 characters in length.	test
MobilePhone	string	No	The mobile number of the RAM user. Format: Country code-Mobile phone number. Note This parameter is valid only on the China site (aliyun.com).	86-1868888****
Email	string	No	The email address of the RAM user. Note This parameter is valid only on the China site (aliyun.com).	alice@example.com
Comments	string	No	The description. The description must be 1 to 128 characters in length.	This is a cloud computing engineer.
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The key of the tag. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.	operator
Value	string	No	The value of the tag. The tag value can be an empty string. The tag value can be up to 128 characters in length. The tag value cannot start with `acs:` or contain `http://` or `https://`.	alice

Response elements

Element	Type	Description	Example
	object	The response parameters.
User	object	The information about the RAM user.
DisplayName	string	The display name of the RAM user.	test
UserPrincipalName	string	The logon name of the RAM user.	test@example.onaliyun.com
Email	string	The email address of the RAM user. Note This parameter is valid only on the China site (aliyun.com).	alice@example.com
UpdateDate	string	The time when the information about the RAM user was updated.	2020-10-12T09:12:00Z
MobilePhone	string	The mobile phone number of the RAM user. Note This parameter is valid only on the China site (aliyun.com).	86-1868888****
UserId	string	The ID of the RAM user.	20732900249392****
Comments	string	The description.	This is a cloud computing engineer.
LastLoginDate	string	The last time when the RAM user logged on to the Alibaba Cloud Management Console.	2020-10-12T09:12:00Z
CreateDate	string	The time when the RAM user was created.	2020-10-12T09:12:00Z
ProvisionType	string	The source of the RAM user. Valid values: Manual: The RAM user is manually created in the RAM console. SCIM: The RAM user is mapped by using System for Cross-domain Identity Management (SCIM). CloudSSO: The RAM user is mapped from a CloudSSO user.	Manual
Tags	object
Tag	array<object>	The tag value.
	object
TagKey	string	The tag key.	operator
TagValue	string	The tag value.	alice
RequestId	string	The request ID.	2BB8C44A-2862-4922-AD43-03924749173B

Examples

Success response

JSON format

{
  "User": {
    "DisplayName": "test",
    "UserPrincipalName": "test@example.onaliyun.com",
    "Email": "alice@example.com",
    "UpdateDate": "2020-10-12T09:12:00Z",
    "MobilePhone": "86-1868888****",
    "UserId": "20732900249392****",
    "Comments": "This is a cloud computing engineer.",
    "LastLoginDate": "2020-10-12T09:12:00Z",
    "CreateDate": "2020-10-12T09:12:00Z",
    "ProvisionType": "Manual",
    "Tags": {
      "Tag": [
        {
          "TagKey": "operator",
          "TagValue": "alice"
        }
      ]
    }
  },
  "RequestId": "2BB8C44A-2862-4922-AD43-03924749173B"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.