Skip to content
You're viewing documentation for v2026.11.10-beta. It may be out of date.Go to latest
TimescaleDB Enterprise
Esc
↑↓navigate↵open⌘Jpreview

Get the two-factor policy

Get the two-factor policy for local users.

GET/api/v1/two-factor-policy
Authorization
tse_sessionAPI key · cookierequired
Responses
200

OK

require_two_factorbooleanrequired

Each local user without TOTP must enrol at the next login

default

Error

codestring

Stable code of the refusal, when the route has codes

detailsstring[]

Additional detail, e.g. per-field validation failures

errorstringrequired

Human-readable error message

Request
curl -X GET 'https://console.example.com/api/v1/two-factor-policy' \
  -H 'Cookie: tse_session=YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "require_two_factor": true
}