Get sign-in options

GET

/api/v1/auth/options

curl --request GET \
  --url https://example.com/api/v1/auth/options

Returns the sign-in options. No sign-in is required. It can return 429 if the request limit is reached. Route: /api/v1/auth/options. Inputs: . Safe reads can use bounded retries.

Responses

200

Media typeapplication/json

Public sign-in options. Provider issuers, client ids and secrets stay on the server: the page only needs a name to start a flow.

object

open_signup

required

boolean

providers

required

Array<object>

object

id

required

The {provider} path segment of the OIDC routes.

string

label

required

string

setup_required

required

boolean

signed_in

required

The request carries a live session with account scope. Lets the sign-in page send a signed-in person on without a 401 probe.

boolean

Example^generated

{
  "open_signup": true,
  "providers": [
    {
      "id": "example",
      "label": "example"
    }
  ],
  "setup_required": true,
  "signed_in": true
}

429

Too many requests

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}