Two Factor Status

curl --request GET \
  --url https://api.example.com/api/auth/2fa/status \
  --header 'Authorization: Bearer <token>'

{
  "enabled": false,
  "pending": false,
  "required": false,
  "backup_codes_total": 0,
  "backup_codes_remaining": 0
}

GET

api

auth

2fa

status

Two Factor Status

curl --request GET \
  --url https://api.example.com/api/auth/2fa/status \
  --header 'Authorization: Bearer <token>'

{
  "enabled": false,
  "pending": false,
  "required": false,
  "backup_codes_total": 0,
  "backup_codes_remaining": 0
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-API-Key

string | null

antidote_session

string | null

Successful Response

enabled

boolean

default:false

pending

boolean

default:false

required

boolean

default:false

backup_codes_total

integer

default:0

backup_codes_remaining

integer

default:0