Authorize new connection

GET/unified/integration/auth/{workspace_id}/{integration_type} NO AUTH NEEDED

Returns an authorization URL for the specified integration. Once a successful authorization occurs, a new connection is created.

Parameters

success_redirectstring
The URL where you want the user to be redirect to after a successful authorization. The connection ID will be appended with (id=<connectionId>) to this URL, as will the state that was provided.
failure_redirectstring
The URL where you want the user to be redirect to after an unsuccessful authentication. An "error" variable will be appended.
statestring
Extra state to send back to your success URL
external_xrefstring
Your user identifier to associate with the new Integration
scopesstring array
redirectboolean
envstring default=Production
langstring
Language: en, fr, es, it, pt, zh, hi
subdomainstring
Optional tenant domain or subdomain for integrations that require it to build the authorize, token, or API URL. Depending on the integration, this may be a bare subdomain or a full domain/URL.
regionstring
Optional region index (into the integration api.urls array) selected by the end-user. Set automatically by the auth widget when the workspace integration has prompt_region=true.
workspace_idstring required
The ID of the workspace
integration_typestring required
Type of the supported integration

Returns

string
Are we missing anything? Let us know
Was this page helpful?