Get Sso Login Url — GET /api/v1/sso/login-url
Get Sso Login Url
The IdP URL that starts an SP-initiated login: the IdP SSO URL carrying a SAML AuthnRequest (HTTP-Redirect binding) and, when next is an app-relative path, a RelayState the browser returns to after sign-in.
Endpoint: GET /api/v1/sso/login-url
Authentication: No access token or API key is needed.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
next | query | no | string or null |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | object (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
404, with messages such as “No active SSO configuration found”, “SSO is not enabled”502, with the message “The identity provider could not be reached. Contact your administrator”
Statuses not listed here are explained in Errors and retries.
More details
Section titled “More details”- Group: SSO / SAML
- Operation ID:
get_sso_login_url_api_v1_sso_login_url_get - Source code:
backend/app/routers/sso.py, line 204 - Specification: OpenAPI JSON