Querying IAM User Details

Function

This API is used to query IAM user details.

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:getUserV5	Read	user *	g:ResourceTag/<tag-key> iam:ResourceIsRootUser	-	-

URI

GET /v5/users/{user_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	Definition IAM user ID, which is globally unique. For details about how to obtain the user ID, see the API for listing IAM users or check the IAM user details page on the IAM console. Constraints The user ID must exist and be valid. Range The value contains 32 characters, including only letters and digits. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

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

**Table 3** user
Parameter	Type	Description
description	String	Definition Description of the IAM user. Range The value contains 0 to 255 characters and cannot contain special characters "@", "#", "%", "&", "<", ">", "\", "$", "^", and "*".
user_name	String	Definition IAM username. Range 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	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. The UTC time format is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-13T06:51:20.550Z. Range N/A
user_id	String	Definition IAM user ID, which is globally unique. For details about how to obtain the user ID, see the API for listing IAM users or check the IAM user details page on the IAM console. Range The value contains 32 characters, including only letters and digits.
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.
tags	Array of tags objects	Definition: List of custom tags. Range: N/A

**Table 4** tags
Parameter	Type	Description
tag_key	String	Definition Tag key. Range The value can contain 1 to 128 characters. Letters, digits, spaces, and the following special characters are allowed: _.:=+-@. The key cannot start with a space or _sys_ or end with a space.
tag_value	String	Definition Tag value. Range The value can be an empty string or contain 0 to 255 characters. Letters, digits, spaces, and the following special characters are allowed: _.:/=+-@.

Status code: 403

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

Example Requests

Querying IAM user details

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

Example Responses

Status code: 200

{
  "user" : {
    "description" : "description",
    "user_name" : "example-user-name",
    "is_root_user" : false,
    "created_at" : "2023-09-13T06:51:20.550Z",
    "user_id" : "0123456789abcdef0123456789abcdef",
    "urn" : "iam::123456789012:user:example-user-01",
    "enabled" : true,
    "tags" : [ {
      "tag_key" : "key",
      "tag_value" : "value"
    } ]
  }
}

Status Codes

Status Code	Description
200	Successful
403	Forbidden
404	Not found

Error Codes

See Error Codes.

Parent topic: Managing IAM Users

Previous topic: Querying the Last Login Time of an IAM User

Next topic: Modifying an IAM User