SSO Authentication
Initiate SSO Authentication (Service Provider-Initiated Flow)
Initiates the SSO authentication process by redirecting the user to their configured Identity Provider (IdP).
What this endpoint does:
- Looks up the SSO configuration based on the user's email domain
- Generates a SAML authentication request
- Returns the SAML request in a 200 or 303 response depending on request parameters
Note: This does not authenticate the user directly. It starts the redirect flow to the IdP.
post/v2/authn/sso/{emailAddress}
Request
- Base URLhttps://api.alianza.com
- AuthAPI key in header X-AUTH-TOKEN
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
emailAddressstring email required
The user's email address, used to identify the SSO configuration by email domain
Query parameters
redirectboolean
When true, returns HTTP 303 and may include a Location header. When false, returns HTTP 200 with the redirect URL in the response body.
Headers
X-AUTH-REDIRECT-OVERRIDEstring uri
Optional redirect URL override for specific applications. If provided, the user will be redirected to this URL after successful authentication instead of the default callback URL.
Response
Redirect URI generated successfully
Example response
{
"redirectUri": "https://idp.example.com/login?SAMLRequest=abc123"
}Changes
No recorded changes to this operation across all 1 revision of this API.