API ReferenceSAML

Get SAML Redirect Url

Gets a SAML initiation URL to redirect your users to.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
samlConnectionIdstringOptional

The SAML connection to start a SAML login for.

One of samlConnectionId, organizationId, or organizationExternalId must be specified.

organizationIdstringOptional

The ID of the organization to start a SAML login for.

The primary SAML connection in this organization will be used for logins.

One of samlConnectionId, organizationId, or organizationExternalId must be specified.

organizationExternalIdstringOptional

The externalId of the organization to start a SAML login for.

The primary SAML connection in this organization will be used for logins.

One of samlConnectionId, organizationId, or organizationExternalId must be specified.

statestringOptional

This string will be returned back to you when you redeem this login’s SAML access code.

You can do anything you like with this state, but the most common use-case is to keep track of where to redirect your user back to after logging in with SAML.

Response

OK
redirectUrlstring or null
Redirect your user to this URL to start a SAML login.