Begin an OIDC login: the IdP authorization URL the browser should be sent to. The CSRF `state`, `nonce` and PKCE verifier are stashed server-side for the flight. Unauthenticated (pre-session).
const url = 'https://example.com/api/v1/auth/oidc/authorize';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/auth/oidc/authorizeAuthorizations
Section titled “Authorizations”- None
Responses
Section titled “Responses”The IdP authorization URL the browser should be sent to
Where to send the browser to start the SSO handshake.
object
Examplegenerated
{ "authorize_url": "example"}Provider discovery or configuration failed
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}No OIDC provider store, or no provider enabled
The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI
document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies
undescribed — a client that has to guess the failure shape ends up parsing the success shape and
reading undefined.
object
object
Stable machine-readable code. Clients branch on this, never on the message.
Operator-facing sentence. Safe to display; never carries an internal error’s own text.
Examplegenerated
{ "error": { "code": "example", "message": "example" }}