Resource Access Management:UpdateUser - Resource Access Management - Alibaba Cloud - Resource Access Management

Invokes UpdateUser to modify the information of a Resource Access Management (RAM) user.

Operation description

This topic provides an example to show how to modify the name of a RAM user from test@example.onaliyun.com to new@example.onaliyun.com.

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:UpdateUser

update

*User

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

None

Request parameters

Parameter	Type	Required	Description	Example
UserPrincipalName	string	No	The logon name of the specified Resource Access Management (RAM) user. Note You must specify either the `UserPrincipalName` or `UserId` parameter, but not both.	test@example.onaliyun.com
UserId	string	No	The ID of the specified Resource Access Management (RAM) user. Note You must specify either the `UserPrincipalName` or `UserId` parameter, but not both.	20732900249392****
NewUserPrincipalName	string	No	The new logon name of the Resource Access Management (RAM) user. The format is `<username>@<AccountAlias>.onaliyun.com`, where `<username>` is the RAM username and `<AccountAlias>.onaliyun.com` is the default domain name. The `UserPrincipalName` must be 1 to 128 characters in length and can contain letters, digits, periods (.), hyphens (-), and underscores (_). The `<username>` must be 1 to 64 characters in length.	new@example.onaliyun.com
NewDisplayName	string	No	The new display name of the Resource Access Management (RAM) user. The name must be 1 to 24 characters in length.	new
NewMobilePhone	string	No	The new mobile phone number of the Resource Access Management (RAM) user. Format: area code-phone number. Note This parameter is applicable only to China site (aliyun.com).	86-1868888****
NewEmail	string	No	The new email address of the Resource Access Management (RAM) user. Note This parameter is applicable only to China site (aliyun.com).	alice@example.com
NewComments	string	No	The new comments. The comments must be 1 to 128 characters in length.	This is a cloud computing engineer.

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
User	object	The Resource Access Management (RAM) user information.
DisplayName	string	The display name of the Resource Access Management (RAM) user.	new
UserPrincipalName	string	The logon name of the Resource Access Management (RAM) user.	new@example.onaliyun.com
Email	string	The email address of the Resource Access Management (RAM) user. Note This parameter is applicable only to China site (aliyun.com).	alice@example.com
UpdateDate	string	The time when the Resource Access Management (RAM) user was last updated. Format: RFC 3339 (UTC). Example: 2020-10-13T09:19:49Z.	2020-10-13T09:19:49Z
MobilePhone	string	The mobile phone number of the Resource Access Management (RAM) user. Note This parameter is applicable only to China site (aliyun.com).	86-1868888****
UserId	string	The ID of the Resource Access Management (RAM) user.	20732900249392****
Comments	string	The comments.	This is a cloud computing engineer.
LastLoginDate	string	The most recent time when the Resource Access Management (RAM) user logged on to the console. Format: RFC 3339 (UTC). Example: 2020-10-12T09:12:00Z.	2020-10-12T09:12:00Z
CreateDate	string	The time when the Resource Access Management (RAM) user was created. Format: RFC 3339 (UTC). Example: 2020-10-12T09:12:00Z.	2020-10-12T09:12:00Z
ProvisionType	string	The synchronization type. Valid values: Manual: The Resource Access Management (RAM) user was manually created in RAM. SCIM: The Resource Access Management (RAM) user was created by using the System for Cross-domain Identity Management protocol. CloudSSO: The user was created by using CloudSSO.	Manual
RequestId	string	The request ID.	1B56DD42-6962-4F89-A19C-079EED1F0FE3

Examples

Success response

JSON format

{
  "User": {
    "DisplayName": "new",
    "UserPrincipalName": "new@example.onaliyun.com",
    "Email": "alice@example.com",
    "UpdateDate": "2020-10-13T09:19:49Z",
    "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"
  },
  "RequestId": "1B56DD42-6962-4F89-A19C-079EED1F0FE3"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.