Docmost Octri Preview
POST/mfa/setup

Generate MFA setup data

Generates the setup data needed to configure multi-factor authentication. Use the returned QR code and secret to configure an authenticator app before enabling MFA. Setup data cannot be generated while MFA is already enabled.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 status codes
200Returns MFA setup data, including the QR code and secret.
dataobjectoptional
statusintegeroptional
successbooleanoptional
400Returned when MFA is already enabled.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 400 is returned when MFA is already enabled. Disable MFA before requesting setup data.