Skip to Content
ReferenceAPI referenceAuth

List the login methods this server offers

GET
/api/v1/auth/options

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.

Response Body

Request fulfilled, document follows

application/json
  1. response

The login methods this server offers.

oidc*|null
password*boolean

Whether the username and password login is on.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/auth/options'
Example Response200
{  "oidc": {    "providerName": "string"  },  "password": true}

Get the OIDC single sign-on status GET

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.

List CrowdSec alerts, newest first GET

Returns one page of the LAPI's alert history, newest first, without the community blocklist pulls. Pass the `nextCursor` of one page as `before` to get the next, older one. An IP source without a country from the LAPI gets its place from GeoMetrikks' own traffic, then from the GeoIP database. Answers 403 when the server has no CrowdSec machine credentials, CROWDSEC_MACHINE_ID and CROWDSEC_MACHINE_PASSWORD.