Administration

Get a user's two-factor status

GET/api/admin/users/{userId}/2fa

Returns whether two-factor authentication is enabled for the specified user.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Name	Type	Description
userIdrequired	string	ID of the associated user.

200The operation completed successfully.

Name	Type	Description
isEnabledrequired	boolean	Whether two-factor authentication is enabled.

200 example

{
  "isEnabled": true
}

401Unauthorized.

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

401 example

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

404Not found.

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

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

cURL

curl -X GET 'https://api.example.com/api/admin/users/{userId}/2fa' \
  -H 'Authorization: Bearer <token>'