MFA API
The MFA operations of the BuildBase HTTP API: method, path, sign-in, request fields, answers and errors for each.
8 operations, 7 fully described. For how this part of BuildBase works, start with the guide.
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/public/mfa | Get the signed-in person's two-step sign-in status |
| POST | /api/v1/public/mfa/backup-codes/regenerate | Replace the backup codes for the authenticator app |
| POST | /api/v1/public/mfa/sms/disable | Turn off text-message codes as a second step |
| POST | /api/v1/public/mfa/sms/enroll | Send the code that turns on text-message codes as a second step |
| POST | /api/v1/public/mfa/sms/enroll/confirm | Confirm text-message codes as a second step with the texted code |
| POST | /api/v1/public/mfa/totp/confirm | Confirm an authenticator app with its first code |
| POST | /api/v1/public/mfa/totp/disable | Remove the authenticator app |
| POST | /api/v1/public/mfa/totp/enroll | Start setting up an authenticator app |
Related
- API reference: every tag
- MFA guide