Skip to Content
ReferenceAPI referenceAuth

Log in with the admin username and password

POST
/api/v1/auth/login

Checks the admin username and password, starts a browser session and sets its cookie. Wrong credentials get a 401, and so does every attempt while password login is off because only OIDC is set up. A 503 means the database is down and nobody can log in. With APP_AUTH_DISABLED=true it checks nothing and answers with mode set to disabled.

Request Body

application/json
  1. body

The admin username and password.

password*string
username*string

Response Body

Request fulfilled, document follows

application/json
  1. response

The user of the current browser session.

mode*string
provider*string

How the user logged in, with the admin password or through OIDC single sign-on.

Value in"password""oidc"
username*string
Example Request
curl -X POST 'https://geometrikks.example.com/api/v1/auth/login' \  -H 'Content-Type: application/json' \  -d '{  "password": "string",  "username": "string"}'
Example Response
{  "mode": "session",  "provider": "password",  "username": "string"}

Check credentials and configured API features GET

Returns the app/API version and configured features without checking external services. API-key requests also return that key's name, scope and expiry. Invalid or expired keys get a coded 401 before this handler runs. Browser sessions return mode=session. With APP_AUTH_DISABLED=true, mode=disabled means a supplied key has not been validated.

Log out and end the browser session POST

Ends the current session. After an OIDC login with OIDC_LOGOUT_IDP on, `redirectTo` holds the identity provider's sign-out URL, as long as the provider lists an end_session_endpoint. API keys get a 403 here; use a browser session.