v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Authentication

Create a consumer access token

Issues a new access token for the identity supplied in the request. Pass an email to identify a consumer when the client identity key is email. Pass a jwt to assert a trusted identity via JWT verification. Omit both to issue an anonymous token. The optional duration_seconds field caps the token lifetime.

post/api/v5/token

Request body

duration_secondsinteger nullable required

Requested token lifetime in seconds. Defaults to the client configuration value when omitted.

emailstring nullable required

Email address used to identify or create the consumer. Ignored when jwt is present.

jwtstring nullable required

Signed JWT carrying consumer identity claims. When supplied, identity is derived from the token claims rather than from email.

Response

Created consumer access token.

access_tokenstring required

Opaque access token for the consumer session. Pass as a Bearer token or access_token query parameter on subsequent requests.

expires_ininteger required

Seconds until the token expires.

scopesstring[] required

Set of permission scopes granted to this token.