Querying All Permanent Access Keys

Function

This API is used to query all permanent access keys of 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:credentials:listCredentialsV5	List	user *	g:ResourceTag/<tag-key>	-	-

URI

GET /v5/users/{user_id}/access-keys

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records displayed on each page. The value ranges from 1 to 200. The default value is 100. Minimum: 1 Maximum: 200 Default: 100
marker	No	String	Pagination marker. The value contains 4 to 400 characters, including only letters, digits, and the following special characters: +/=-_ Minimum: 4 Maximum: 400

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
access_keys	Array of AccessKeyMetadata objects	List of permanent access keys.
page_info	PageInfo object	Pagination information.

**Table 4** AccessKeyMetadata
Parameter	Type	Description
user_id	String	IAM user ID.
access_key_id	String	Permanent access key ID (AK).
created_at	String	Time when the access key was created.
status	String	Status of the access key. The value can be active or inactive.

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	If this parameter exists, there are subsequent items that are not displayed in the current response body. The value can be used as the pagination marker parameter for the next request to obtain information about the next page. This API can be repeatedly called until this field does not exist.
current_count	Integer	Number of items returned on this page.

Status code: 400

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

Status code: 403

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

Example Requests

Querying all permanent access keys of an IAM user

GET https://{endpoint}/v5/users/{user_id}/access-keys

Example Responses

Status code: 200

Successful

{
  "access_keys" : [ {
    "user_id" : "user",
    "access_key_id" : "access",
    "created_at" : "2023-09-13T06:51:20.550Z",
    "status" : "active"
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}