API ReferenceSAML

Get SAML Redirect Url

Get a URL to initiate a SAML login.

Request

This endpoint expects an object.
samlConnectionIdstringOptional
The SAML connection to log in with.
organizationIdstringOptional
The organization to log in with, identified by ID. This will use the organization's primary SAML connection.
organizationExternalIdstringOptional
The organization to log in with, identified by external ID. This will use the organization's primary SAML connection.
statestringOptional
An arbitrary string that will be returned back in the SAML login's corresponding RedeemSAMLAccessCode call.

Response

This endpoint returns an object.
redirectUrlstring or null
Redirect your user to this URL to initiate the SAML login.