Modifying an IAM User

Function

This API is used to modify an IAM user.

Authorization Information

Each account root user 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> iam:ResourceIsRootUser	-	-

URI

PUT /v5/users/{user_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	Definition: IAM user ID. Constraints: The user ID must exist and be valid. Range: 32 bits. Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
new_user_name	No	String	Definition: IAM username. Constraints: The value contains 1 to 64 characters, including only letters, digits, underscores (_), hyphens (-), periods (.), and spaces, and cannot start with a digit. Range: N/A Default Value: N/A
new_description	No	String	Definition: Description of the IAM user. Constraints: The value contains 0 to 255 characters and cannot contain special characters "@", "#", "%", "&", "<", ">", "\", "$", "^", and "". Range: N/A Default Value*: N/A
enabled	No	Boolean	Definition: Whether the IAM user is enabled. Constraints: NOTE: Do not use this parameter to disable the root user of an account. Disabling the root user will result in abnormal system access. Range: The value can be true or false. Default Value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
user	user object	Definition: IAM user. Range: N/A

**Table 4** user
Parameter	Type	Description
description	String	Definition: Description of the IAM user. Range: N/A
user_name	String	Definition: IAM username. Range: N/A
is_root_user	Boolean	Definition: Whether an IAM user is the root user. Range: The value can be true or false.
created_at	String	Definition: Time when an IAM user was created. Range: N/A
user_id	String	Definition: IAM user ID, which is globally unique. Range: N/A
urn	String	Definition : Uniform Resource Name (URN). For details, see Reference. Range: N/A.
enabled	Boolean	Definition: Whether the IAM user is enabled. Range: The value can be true or false.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A
encoded_authorization_message	String	Definition : Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

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
  }
}