Get a user API key

edit

Retrieves the API key metadata for a user.

Request

edit

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

Path parameters

edit
Name Type Required Description

api_key_id

string

Y

The API Key ID.

user_id

string

Y

The user ID.

Responses

edit
200

(ApiKeyResponse)

The API key metadata is retrieved.

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

Request example

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