Skip to main content
POST

Authorizations

​
Authorization
string
header
required

JWT bearer token obtained via the OAuth2 client-credentials grant from the platform Authentication API. The token's scopes gate the endpoints it may call, and its audience names the Guardian instance. This is the standard way to authenticate to Guardian.

Body

application/json
​
payload
object
required

The payload is a key-value map, that can contain any information the user wants to store in the token.

  • Maximum 20 key-value pairs. * Maximum 20 characters per key. * Maximum 80 characters per value.
​
expiration_time
integer

The expiry time is used to specify after how many seconds a token should be automatically deleted after creation.

Required range: 1 <= x <= 2592000
Example:

3600

​
metadata
object

Metadata consisting of key-value entries.

  • Maximum 20 key-value pairs.
  • Maximum 20 characters per key.
  • Maximum 80 characters per value.
Example:
​
type_id
string<uuid>

The ID of a type to apply for this payload. If provided the payload will be validated against the schema of the type and the tokens can be filtered by the type ID as well.

Example:

"9e5b3f7d-2c8a-4b6e-a1d9-6f4c8b2e5a7d"

Response

Success response

​
id
string<uuid>
required
Example:

"7b3e9d1f-5a8c-4e2b-9d6f-3c7a1e5b9d4f"

​
created_at
string<date-time>
required
Example:

"2026-03-10T14:00:00Z"

​
expires_at
string<data-time>
Example:

"2026-03-10T15:00:00Z"

​
metadata
object

Metadata consisting of key-value entries.

  • Maximum 20 key-value pairs.
  • Maximum 20 characters per key.
  • Maximum 80 characters per value.
Example: