Querying IAM User Details

Function

This API is used to query IAM user details.

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

URI

GET /v5/users/{user_id}

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

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
user	UserEx object	IAM user.

**Table 3** UserEx
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.
tags	Array of Tag objects	List of custom tags.

**Table 4** Tag
Parameter	Type	Description
tag_key	String	Tag key. The value can contain 1 to 64 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. Minimum: 1 Maximum: 64
tag_value	String	Tag value. The value can be an empty string or contain 0 to 128 characters. Letters, digits, spaces, and the following special characters are allowed: _.:/=+-@ Minimum: 0 Maximum: 128

Status code: 403

**Table 5** 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 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Requests

Querying IAM user details

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

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