Modifying a Specified Permanent Access Key

Function

This API is used to modify a specified permanent access key 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:updateCredentialV5	Write	user *	g:ResourceTag/<tag-key>	-	-

URI

PUT /v5/users/{user_id}/access-keys/{access_key_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	IAM user ID.
access_key_id	Yes	String	Permanent access key ID (AK). Minimum: 1 Maximum: 40

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	String	Status of the access key. The value can be active or inactive.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
access_key	AccessKeyMetadata object	Permanent access key.

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

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

Setting the status of a specified permanent access key of an IAM user to Enabled

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

{
  "status" : "active"
}

Example Responses

Status code: 200

Successful

{
  "access_key" : {
    "user_id" : "user",
    "access_key_id" : "access",
    "created_at" : "2023-09-13T06:51:20.550Z",
    "status" : "active"
  }
}