Creating a Permanent Access Key

Function

This API is used to create a permanent access key for an IAM user.

AKs or SKs are identity credentials for using development tools (API, CLI, and SDK) to access resources and cannot be used for console login. AK is a unique identifier used in conjunction with SK to sign requests cryptographically, ensuring that the requests are secret, complete, and correct.

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

URI

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

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

Request Parameters

None

Response Parameters

Status code: 201

**Table 2** Response body parameters
Parameter	Type	Description
access_key	AccessKey object	Created permanent access key.

**Table 3** AccessKey
Parameter	Type	Description
user_id	String	IAM user ID.
access_key_id	String	ID of the created permanent access key (AK).
created_at	String	Time when the access key was created.
secret_access_key	String	Created SK.
status	String	Status of the access key. The value can be active or inactive.

Status code: 400

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

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

Creating a permanent access key for an IAM user

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

Example Responses

Status code: 201

Successful

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