Reissue Recovery Codes — POST /api/v1/auth/mfa/recovery-codes
Reissue Recovery Codes
Replace the recovery-code set. The previous codes stop working.
Endpoint: POST /api/v1/auth/mfa/recovery-codes
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>. API keys are refused.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
application/json | MfaRecoveryCodesRequest | yes |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | MfaRecoveryCodesResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
400, with messages such as “A valid authenticator code or recovery code is required”, “Password is incorrect”409, with the message “MFA is not enabled for this account”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Authentication
- Operation ID:
reissue_recovery_codes_api_v1_auth_mfa_recovery_codes_post - Source code:
backend/app/routers/mfa.py, line 512 - Specification: OpenAPI JSON