Generate User Key Endpoint

POST

/admin/generate-user-key

curl --request POST \
  --url https://example.com/admin/generate-user-key \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-AdminKey: <X-Tenzir-AdminKey>' \
  --data '{ "user_id": "example", "expires": 1, "tenant_ids": [ "example" ] }'

Authorizations

• Admin Key

Request Body ^required

Media type application/json

UserKey

The decrypted X-Tenzir-UserKey header

object

user_id

required

User Id

string

expires

Expires

integer

tenant_ids

required

Tenant Ids

Array<string>

Example ^generated

{
  "user_id": "example",
  "expires": 1,
  "tenant_ids": [
    "example"
  ]
}

Responses

200

Successful Response

Media type application/json

KeyResponse

object

key

required

Key

string

Example ^generated

{
  "key": "example"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}