Two-factor authentication

Get two-factor authentication status

GET/api/2fa/status

Returns whether two-factor authentication is enabled, configured, or required for the current user, including the reason it is required.

Try it

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.

200The operation completed successfully.

Name	Type	Description
anyOf	anyOf

200 example

{
  "globalRequired": true,
  "isConfigured": true,
  "isEnabled": true,
  "isRequired": true,
  "requiredReason": null
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

cURL

curl -X GET 'https://api.example.com/api/2fa/status' \
  -H 'Authorization: Bearer <token>'