Issue an API token

POST

/v1/tokens

curl --request POST \
  --url https://example.com/v1/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "role": "example", "superadmin": false, "tenant": "example" }'

• this engine

Issues one API token. The secret is returned once, at issue time, and is never readable again.

Authorizations

• bearerAuth

Request Body ^required

Media type application/json

object

name

required

string

role

string

superadmin

boolean

tenant

string

Responses

201

Created

Media type application/json

object

id

string format: uuid

name

string

token

The opaque API key (olvk_…). Shown only once.

string

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "token": "example"
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}