Two-factor authentication

Set up two-factor authentication

POST/api/2fa/setup/initiate

Starts or replaces the current user's pending setup and returns a QR code and manual setup key for an authenticator app.

Headers

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

200The operation completed successfully.

Name	Type	Description
manualKeyrequired	string	Secret key for manually configuring an authenticator app.
qrCodeDataUrlrequired	string	Data URL of the QR code for authenticator setup.

200 example

{
  "manualKey": "string",
  "qrCodeDataUrl": "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
  }
}

cURL

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