Sign in

v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
auth
saml

Sign in a user via SAML

Returns a SAML authentication URL for the specified integration. Once a successful authentication occurs, the name and email are returned inside a jwt parameter, which is a JSON web token that is base-64 encoded.

get/unified/integration/saml/{workspace_id}/{integration_type}

Path parameters

workspace_idstring required

The ID of the workspace

integration_typestring required

Type of the supported integration

Query parameters

success_redirectstring

The URL where you want the user to be redirect to after a successful authentication/sign-in. A "jwt" parameter will be appended to the URL which will contain a name and email of the user who just signed-in.

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

redirectboolean
envstring

Response

Successful