BEbencherdev
users
keys

List user API keys

Changed on

List all bencher_user_* API keys for a user. Only the authenticated user themselves and server admins have access to this endpoint. This endpoint requires a user session: neither a user API key nor a deprecated user API token can list keys. By default, the keys are sorted in alphabetical order by name. The HTTP response header X-Total-Count contains the total number of keys.

get/v0/users/{user}/keys

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

userstring required

The slug or UUID for a user.

Query parameters

direction'asc' | 'desc'

The direction to sort by. If not specified, the default sort direction is used.

pageinteger nullable

The page number to return. If not specified, the first page is returned.

per_pageinteger nullable

The number of items to return per page. If not specified, the default number of items per page (8) is used.

sort'name'

Sort by key name.

The field to sort by. If not specified, the default sort field is used.

namestring

Filter by key name, exact match.

revokedboolean nullable

If set to true, only returns revoked keys. If not set or set to false, only returns non-revoked keys.

searchstring

Search by key name or UUID.

Response

successful operation

creationstring date-time required
expirationstring date-time required
namestring required
revokedstring date-time
userstring uuid required
uuidstring uuid required

Changes