/api/ee/mfa

POST /api/ee/mfa/enroll

Changed on

Start TOTP enrollment for the current user. Requires the account password (LDAP users re-bind against the directory) and the :multi-factor-auth feature. Returns the Base32 secret and an otpauth_uri for QR display; enrollment is not active until confirmed with a live code.

post/api/ee/mfa/enroll

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

passwordstring required

value must be a non-blank string.

Response

Successful response

otpauth_uristring required

value must be a non-blank string.

secretstring required

value must be a non-blank string.

Changes