Sign in

v1

latestOpenAPI 3.0.02026-07-14135106116.2 KB
auth

Create a new API Key on inbox level

The requesting user needs to have inbox level permissions

API Keys are simple randomly generated strings bound to roles that grant access to resources.

Every API Key maps to attributes defining its validity and can be revoked at any time.

API Key can be passed in the X-API-Key HTTP Header and in the querystring &api_key=

Permission required: edit_backend_settings

post/auth/api-key/inbox/{inbox_id}

Headers

X-Fieldsstring mask

An optional fields mask

Request body

activeboolean

Is the API Key active or not

expire_atstring date-time

Expiration date

userstring required

User to give to the bearer

Example request

{
  "roles": [
    {
      "inbox": "abcdef123456789abcdef123",
      "role": "abcdef123456789abcdef123"
    }
  ]
}

Response

Success

activeboolean required

Is the API Key active or not

expire_atstring date-time

The date at which the API Key will expire

tokenstring required

Token value

userstring required

Bearer user

Example response

{
  "roles": [
    {
      "inbox": "abcdef123456789abcdef123",
      "role": "abcdef123456789abcdef123"
    }
  ]
}