Skip to main content
POST
Exchange an identity assertion for a member token

Body

application/x-www-form-urlencoded
grant_type
string
default:""

Must be urn:ietf:params:oauth:grant-type:token-exchange.

subject_token
string
default:""

The identity assertion naming the member: a signed JWT from an issuer the organization's admin trusts, carrying iss, aud, sub (the member's email), name, presence ('session' or 'none'), jti and exp.

subject_token_type
string
default:""

Must be urn:ietf:params:oauth:token-type:jwt.

actor_token
string
default:""

The app's own machine access token, as issued by the machine token endpoint. May instead be sent as Authorization: Bearer ; use one of the two, never both.

actor_token_type
string
default:""

Must be urn:ietf:params:oauth:token-type:access_token when actor_token is sent in the form.

scope
string
default:""

Optional space-delimited scopes for the member token. Leave empty for everything the approval allows; any scope outside the approval's ceiling is refused with access_denied, never dropped.

Response

A read-only token acting as the member was issued.

OAuth2 token-exchange response (RFC 8693 §2.2.1): a short-lived token that acts as one member.

access_token
string
required

Bearer token that acts as the member named by the identity assertion. Send it unchanged as Authorization: Bearer . It is read-only and expires after expires_in seconds.

issued_token_type
string
required

Always urn:ietf:params:oauth:token-type:access_token.

expires_in
integer
required

Token lifetime in seconds; exchange again shortly before expiry.

scope
string
required

Space-delimited scopes the token carries (never more than the approval allows).

token_type
string
default:Bearer

Token type for the Authorization header: 'Bearer'.