Delete an API key for a user

Delete or invalidate an API key for a user.

Request

DELETE /api/v1/users/{user_id}/auth/keys/{api_key_id}

Path parameters

Name Type Required Description

api_key_id

string

Y

The API Key ID.

user_id

string

Y

The user ID.

Responses

200

(EmptyResponse) The API key is deleted.

404

(BasicFailedReply) The {api_key_id} can't be found. (code: api_keys.key_not_found)

Headers

x-cloud-error-codes (string; allowed values: [api_keys.key_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE https://{{hostname}}/api/v1/users/{user_id}/auth/keys/{api_key_id} \
-H "Authorization: ApiKey $ECE_API_KEY"