Modifying a Permanent Access Key¶

Function¶

This API can be used by the administrator to modify the specified permanent access key of an IAM user or used by an IAM user to modify one of their permanent access keys.

The API can be called using both the global endpoint and region-specific endpoints.

Note

This operation will invalidate your existing token. After the operation is complete, obtain a new token.

URI¶

PUT /v3.0/OS-CREDENTIAL/credentials/{access_key}

**Table 1** URI parameters¶
Parameter	Mandatory	Type	Description
access_key	Yes	String	AK of the access key to be modified.

Request Parameters¶

**Table 2** Parameters in the request header¶
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
X-Auth-Token	Yes	String	A token with Security Administrator permissions is required if the administrator is requesting to modify a specified permanent access key of an IAM user. The user token (no special permission requirements) of an IAM user is required if the user is requesting to modify one of their permanent access keys.

**Table 3** Parameters in the request body¶
Parameter	Mandatory	Type	Description
credential	Yes	Object	Authentication information.

**Table 4** credential¶
Parameter	Mandatory	Type	Description
status	No	String	Status of the access key to be changed to The value can be active or inactive. Options: active inactive
description	No	String	Description of the access key

Response Parameters¶

**Table 5** Parameters in the response body¶
Parameter	Type	Description
credential	Object	Authentication information.

**Table 6** credential¶
Parameter	Type	Description
user_id	String	IAM user ID.
access	String	AK.
status	String	Status of the access key.
create_time	String	Time when the access key was created.
description	String	Description of the access key.

Example Request¶

PUT https://sample.domain.com/v3.0/OS-CREDENTIAL/credentials/{access_key}

{
    "credential": {
        "status": "inactive",
        "description": "IAMDescription"
    }
}

Example Response¶

Status code: 200

The request is successful.

{
    "credential": {
        "status": "inactive",
        "access": "LOSZM4YRVLKOY9...",
        "create_time": "2020-01-08T06:26:08.123059Z",
        "user_id": "07609fb9358010e21f7bc00375..."
    }
}

Status Codes¶

Status Code	Description
200	The request is successful.
400	The server failed to process the request.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.
500	Internal server error.

Error Codes¶

None

last updated: 2024-11-08 14:24 UTC - commit: 2d5e2c1f97c685df3090da66769505f099a4c992