Skip to Content
ReferenceAPI referenceAuth

Get the OIDC single sign-on status

GET
/api/v1/auth/oidc/status

Reports whether OIDC is configured, whether discovery against the issuer worked and the last discovery error. It also says whether password login and identity provider logout are on. API keys get a 403 here; use a browser session.

Authorization

sessionCookie
cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

The state of OIDC single sign-on, as Settings > Status shows it.

configured*boolean
detail*|

The error from the last failed discovery attempt, else null.

discovery*string

Whether reading the issuer's discovery document worked. pending means no attempt has finished yet, or OIDC is not configured.

Value in"ok""failed""pending"
idpLogout*boolean

OIDC_LOGOUT_IDP. When true, logout also ends the identity provider session if the provider lists an end_session_endpoint.

issuer*string|null
passwordLogin*boolean

Whether the username and password login is on.

providerName*string|null
Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/auth/oidc/status'
Example Response
{  "configured": true,  "detail": "string",  "discovery": "ok",  "idpLogout": true,  "issuer": "string",  "passwordLogin": true,  "providerName": "string"}

Get the logged-in user GET

Returns the username and how the user logged in. A request without a session gets a 401. With APP_AUTH_DISABLED=true it answers with `mode` set to `disabled`. API keys get a 403 here; use a browser session.

List the login methods this server offers GET

Says whether password login is on and, when OIDC single sign-on is set up, gives the provider's name. It needs no credentials, so the login page can call it first. With APP_AUTH_DISABLED=true both are off.