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 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:credentials:updateCredentialV5	Write	user *	g:ResourceTag/<tag-key> iam:ResourceIsRootUser	-	-

URI

PUT /v5/users/{user_id}/access-keys/{access_key_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
access_key_id	Yes	String	Definition : Permanent access key ID (AK). For details about how to obtain it, see Reference. Constraints: See the preceding reference link. Range: N/A. Default Value: N/A.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	String	Definition: Access key status. Constraints: N/A Range: active or inactive. Default Value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
access_key	access_key object	Definition: Permanent access key. Range: N/A

**Table 4** access_key
Parameter	Type	Description
user_id	String	Definition: IAM user ID, which is globally unique. Range: N/A
access_key_id	String	Definition : Permanent access key ID (AK). For details about how to obtain it, see Reference. Range: N/A.
created_at	String	Definition: Time when the access key was created. Range: N/A
status	String	Definition: Access key status. Range: active or inactive.

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

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