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

Creates a Resource Access Management (RAM) user.

Operation description

This topic provides an example on how to create a RAM user named test.

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 Resource Access Management (RAM) user. The format is `<username>@<AccountAlias>.onaliyun.com`, where `<username>` is the Resource Access Management (RAM) user and `<AccountAlias>.onaliyun.com` is the default domain name. For more information about how to obtain the default domain name, see GetDefaultDomain. The UserPrincipalName parameter must be 1 to 128 characters in length and can contain letters, digits, periods (.), hyphens (-), and underscores (_). The `<username>` part must be 1 to 64 characters in length.	Test@example.onaliyun.com
DisplayName	string	Yes	The display name of the Resource Access Management (RAM) user. The display name must be 1 to 24 characters in length.	test
MobilePhone	string	No	The mobile phone number of the Resource Access Management (RAM) user. Format: area code-phone number. Note This parameter is applicable only to the China site.	86-1868888****
Email	string	No	The electron mailbox of the Resource Access Management (RAM) user. Note This parameter is applicable only to the China site.	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 list of tags. A maximum of 20 tags can be added.
	object	No	The list of tags. A maximum of 20 tags can be added.
Key	string	No	The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://.	operator
Value	string	No	The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with acs:. It cannot contain http:// or https://.	alice

For more information about common request parameters, see API Reference.

Response elements

Element	Type	Description	Example
	object	The response.
User	object	The Resource Access Management (RAM) user information.
DisplayName	string	The display name of the Resource Access Management (RAM) user.	test
UserPrincipalName	string	The logon name of the Resource Access Management (RAM) user.	test@example.onaliyun.com
Email	string	The electron mailbox of the Resource Access Management (RAM) user. Note This parameter is applicable only to the China site.	alice@example.com
UpdateDate	string	The update time of the Resource Access Management (RAM) user. Format: RFC 3339 (UTC), such as 2020-10-12T09:12:00Z.	2020-10-12T09:12:00Z
MobilePhone	string	The mobile phone number of the Resource Access Management (RAM) user. Note This parameter is applicable only to the China site.	86-1868888****
UserId	string	The ID of the Resource Access Management (RAM) user.	20732900249392****
Comments	string	The description.	This is a cloud computing engineer.
LastLoginDate	string	The time of the last logon to the console by the Resource Access Management (RAM) user. Format: RFC 3339 (UTC), such as 2020-10-12T09:12:00Z.	2020-10-12T09:12:00Z
CreateDate	string	The creation time of the Resource Access Management (RAM) user. Format: RFC 3339 (UTC), such as 2020-10-12T09:12:00Z.	2020-10-12T09:12:00Z
ProvisionType	string	The provision type. Valid values: Manual: The Resource Access Management (RAM) user is manually created in RAM. SCIM: The Resource Access Management (RAM) user is created through the System for Cross-domain Identity Management protocol. CloudSSO: The user is created through CloudSSO synchronization.	Manual
Tags	object
Tag	array<object>	The list of tags.
	object	The list of tags.
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.