Start Enrollment — POST /api/v1/auth/mfa/enroll/start
Start Enrollment
Generate a TOTP seed and provisioning URI. Does not enable MFA.
Endpoint: POST /api/v1/auth/mfa/enroll/start
Authentication: No access token or API key is needed.
Parameters
Section titled “Parameters”This endpoint takes no parameters.
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
application/json | MfaEnrollStartRequest | yes |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | MfaEnrollStartResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
409, with the message “MFA is already enabled. Disable it first to enroll a new device”
Statuses not listed here are explained in Errors and retries.
More details
Section titled “More details”- Group: Authentication
- Operation ID:
start_enrollment_api_v1_auth_mfa_enroll_start_post - Source code:
backend/app/routers/mfa.py, line 261 - Specification: OpenAPI JSON