get__mfa_status

GET /mfa/status

Get MFA Status

Retrieve the current multi-factor authentication status for the authenticated user, including enabled methods and enforcement settings.

TypeScript Client Library

// Note: This endpoint doesn't have a direct client method in the provided TypeScript client
// You would need to use the generic makeRequest method:
// this.makeRequest<any>('mfa/status', 'GET', null);

Code Samples

# You can also use wget
curl -X GET https://backend.flashback.tech/mfa/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "success": true,
  "data": {
    "isEnabled": true,
    "isRequired": false,
    "isEnforced": false,
    "enabledMethods": ["GOOGLE_AUTH", "PASSKEY"],
    "primaryMethod": "GOOGLE_AUTH"
  }
}

500 Response

{
  "success": false,
  "error": "Failed to get MFA status"
}

Responses

Status
Meaning
Description
Schema

200

MFA status retrieved successfully

Inline

500

Internal server error

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

object

false

none

MFA status information

»» isEnabled

boolean

false

none

Whether MFA is enabled for the user

»» isRequired

boolean

false

none

Whether MFA is required for the user

»» isEnforced

boolean

false

none

Whether MFA is enforced by organization

»» enabledMethods

[string]

false

none

Array of enabled MFA method types

»» primaryMethod

string

false

none

The user's primary MFA method

Status Code 500

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» error

string

false

none

Error message describing the issue

Enumerated Values

Parameter
Value
Description

» enabledMethods

GOOGLE_AUTH

Google Authenticator TOTP

» enabledMethods

MAGIC_LINK

Magic link email verification

» enabledMethods

PASSKEY

WebAuthn passkey authentication

» primaryMethod

GOOGLE_AUTH

Google Authenticator TOTP

» primaryMethod

MAGIC_LINK

Magic link email verification

» primaryMethod

PASSKEY

WebAuthn passkey authentication

Last updated

Was this helpful?