Token Exchange

Token Exchange

Exchanges an OIDC-compliant ID token from a user's identity provider for a Zus access token that can be used to make API calls

post/auth/token

Request

  • Base URL
    https://api.sandbox.zusapi.com
  • URL
    https://api.sandbox.zusapi.com/auth/token
  • Auth
    HTTP bearer

Request body

subject_tokenstring required

Your ID token generated by your identity provider upon login

custom_unique_identifierstring

Optional unique identifier if you use token exchange for more than one builder in Zus

grant_type'urn:ietf:params:oauth:grant-type:token-exchange'
audience'https://api.zusapi.com'
requested_token_type'urn:ietf:params:oauth:token-type:access_token'
subject_token_type'urn:ietf:params:oauth:token-type:id_token'

Response

Success

access_tokenstring

Zus access token

issued_token_typestring

Type of token issued

token_typestring

Type of token

expires_ininteger

Time until token expiry

Changes

No recorded changes to this operation across all 2 revisions of this API.