Get Auth Mode returns the authentication mode (cloud vs self-hosted)

GET/v1/auth/mode

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Responses

200 Authentication mode and setup status

Property	Type	Description
`mode`	`"AUTH_MODE_UNSPECIFIED" \| "AUTH_MODE_CLOUD" \| "AUTH_MODE_SELF_HOSTED"`	- AUTH_MODE_CLOUD: WorkOS SSO (Cloud edition) - AUTH_MODE_SELF_HOSTED: Email/password + magic link (Self-hosted)
`hasUsers`	`boolean`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X GET "http://localhost:8089/v1/auth/mode" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/v1/auth/mode", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "http://localhost:8089/v1/auth/mode",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "mode": "AUTH_MODE_UNSPECIFIED",
  "hasUsers": true
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}