BEbetagouv
Admin

Create Key

Changed on

Create a new key for a user.

post/v1/admin/keys

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Request body

namestring required

Name of the key.

userinteger required

User ID to create the token for another user (by default, the current user). Required CREATE_USER permission.

expiresinteger nullable

Expiration time, as Unix timestamp. If None, the key never expires.

Example request

{
  "name": "key-1"
}

Response

Successful Response

object'key'

Type of the object.

idinteger required

ID of the key.

namestring required

Name of the key.

valuestring required

Value of the key.

user_idinteger required

ID of the user that owns the key.

expiresinteger nullable

Time of expiration, as Unix timestamp. If None, the key never expires.

createdinteger required

Time of creation, as Unix timestamp.

revokedboolean required

Whether the key has been revoked.

Changes