Modifying an IAM User

Function

This API is used to modify an IAM user.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam:users:updateUserV5	Write	user *	g:ResourceTag/<tag-key>	-	-

URI

PUT /v5/users/{user_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	IAM user ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
new_user_name	No	String	IAM username. The value contains 1 to 64 characters, including only letters, digits, underscores (_), hyphens (-), periods (.), and spaces, and cannot start with a digit.
new_description	No	String	IAM user description. The value can contain 0 to 255 characters and cannot contain the following special characters: @, #, %, &, <, >, \, $, ^, and *.
enabled	No	Boolean	Indicates whether an IAM user is enabled.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
user	User object	IAM user.

**Table 4** User
Parameter	Type	Description
description	String	IAM user description. The value can contain 0 to 255 characters and cannot contain the following special characters: @, #, %, &, <, >, \, $, ^, and *.
user_name	String	IAM username. The value contains 1 to 64 characters, including only letters, digits, underscores (_), hyphens (-), periods (.), and spaces, and cannot start with a digit.
is_root_user	Boolean	Indicates whether an IAM user is a root user.
created_at	String	Time when an IAM user was created.
user_id	String	IAM user ID.
urn	String	Uniform resource name.
enabled	Boolean	Indicates whether an IAM user is enabled.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Requests

Modifying an IAM user

PUT https://{endpoint}/v5/users/{user_id}

{
  "new_user_name" : "name",
  "new_description" : "description",
  "enabled" : true
}

Example Responses

Status code: 200

Successful

{
  "user" : {
    "description" : "description",
    "user_name" : "name",
    "is_root_user" : false,
    "created_at" : "2023-04-26T03:49:42Z",
    "user_id" : "string",
    "urn" : "iam::accountid:user:name",
    "enabled" : true,
    "tags" : [ {
      "tag_key" : "key",
      "tag_value" : "value"
    } ]
  }
}