Administration

Set a user's two-factor requirement

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

Enables or disables the requirement for the specified user to set up two-factor authentication.

Headers

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

Path parameters

Name	Type	Description
userIdrequired	string	ID of the associated user.

Request body

Name	Type	Description
requiredrequired	boolean

Example request

{
  "required": true
}

Responses

200The operation completed successfully.

Name	Type	Description
okrequired	boolean	Whether the operation succeeded.
twoFactorRequiredrequired	any	Whether two-factor authentication is required.
userIdrequired	string	ID of the associated user.

200 example

{
  "ok": true,
  "twoFactorRequired": {},
  "userId": "string"
}

400Bad request.

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

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

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
  }
}

503Service unavailable.

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

503 example

{
  "error": {
    "code": "service-unavailable",
    "message": "Service unavailable.",
    "status": 503
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/admin/users/{userId}/2fa' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "required": true
}'

PreviousSet a team's two-factor requirement NextSet the two-factor requirement for everyone