Skip to main content
POST
Create a session token

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Body

application/json

Request body for creating a new session token.

scopes
string[]
required

Permissions granted to this session token.

Minimum array length: 1
expires_in
integer
default:3600

Token TTL in seconds (60 to 86400).

Required range: 60 <= x <= 86400
settlement_ids
string<uuid>[] | null

Restrict token to specific settlement IDs. Omit the field entirely for an unrestricted token. An empty list is rejected: a caller that computed an empty permitted set is asking for a token that reaches nothing, and silently minting an environment-wide token there would invert the intent.

Minimum array length: 1
metadata
Metadata · object | null

Platform-provided context for audit trail (e.g., user_id, user_email).

Response

Successful Response

Response after creating a session token.

session_token
string
required

The signed JWT to pass to the frontend KeystoneProvider.

expires_at
string<date-time>
required

When the token expires (UTC).

token_id
string<uuid>
required

Token ID for revocation.