Skip to main content

Implementing Single Sign-On

If you have not created an API Client, please visit Create an API Client before continuing.

Request a Token from the API​

To begin, request a token using your created API. For more information on requesting tokens, click here.

Please make sure you do not expose API Client credentials to the browser.

Generate an SSO Login Token​

To initiate an SSO login, exchange your customer user details for an SSO login token. This token can only be used once, after which it will return a sso_token_redeemed error.

API Reference - requestWhiteLabel

Redirect to the White Label Application​

To exchange your sso_login_token for a session, redirect users to a one-time URL built using the code query parameter, like <WHITE_LABEL_DOMAIN>/redirect/sso?code=<SSO_LOGIN_TOKEN>.

Conclusion​

After completing the steps above, place this process behind an authenticated endpoint and button within your portal. This will allow your users to log in to your white label application with a single click.