v7

latestOpenAPI 3.0.3raw.githubusercontent.com2024-10-15203043.0 KB
SSOReadyService

Gets a SAML initiation URL to redirect your users to.

post/v1/saml/redirect

Request body

samlConnectionIdstring

The SAML connection to start a SAML login for.

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

organizationIdstring

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.

organizationExternalIdstring

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.

statestring

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

Redirect your user to this URL to start a SAML login.