API referenceMfa

Your authenticator status

Whether this member has an authenticator, and how much rope is left. `enrolled` without `active` means a setup was started and never confirmed — the screen should offer to finish it rather than to start again, because starting again issues a new secret and invalidates the QR code already on screen. `recovery_codes_remaining` is here because running out and *then* losing the phone is the one state nobody can recover from unaided, and a member cannot be warned about a number they are never shown.

GET
/api/b/v1/mfa

Whether this member has an authenticator, and how much rope is left.

enrolled without active means a setup was started and never confirmed — the screen should offer to finish it rather than to start again, because starting again issues a new secret and invalidates the QR code already on screen.

recovery_codes_remaining is here because running out and then losing the phone is the one state nobody can recover from unaided, and a member cannot be warned about a number they are never shown.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/mfa"
{  "enrolled": true,  "active": true,  "recovery_codes_remaining": 0}