Download OpenAPI specification:Download
Login users using an external SAML identity provider (IDP). B2B apps can use this to allow their business customers or partners to provide SSO login for their members (see Organizations).
Initiates an SSO login flow with a SAML identity provider (IDP). This results in a POST redirect to the SAML IDP configured for the organization, which is determined based on the domain of the user's email address. Once the SAML IDP authenticates the user, it will redirect back to the app with the SAML response so the app can complete the SSO flow.
POST redirect to SAML IDP with a SAML request
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/auth/sso/saml/start?client_id=string&email=string'
Completes the SSO login using the SAML response received directly from the SAML IDP (via your ACS URL). If the user is authenticated and the SAML response is valid, Transmit will redirect to your redirect URI with a code that can be exchanged for a user token. If not, this API returns an error.
This should be called from the backend, using a client access token.
SAML response from the SAML IDP
Organization ID. This can be part of your app's ACS URL path.
URI to redirect to upon completing the SSO login. This is the server GET endpoint used to call the token endpoint, and should accept
- "SAMLResponse": "string",
- "organization_id": "string",
- "redirect_uri": "string",
- "RelayState": "string"
- "result": "string"