MFAStatus

Package: @nauth-toolkit/client Type: Response

User's multi-factor authentication status including enabled methods, preferred method, and exemption status.

import { MFAStatus } from '@nauth-toolkit/client';

Properties

Property	Type	Description
enabled	boolean	Whether MFA is enabled for the user
required	boolean	Whether MFA is required (enabled and has configured devices)
methods	MFADeviceMethod[]	Configured MFA device methods (excludes 'backup')
availableMethods	MFAMethod[]	Available MFA methods including 'backup' if enabled
hasBackupCodes	boolean	Whether user has backup codes available
preferredMethod	MFADeviceMethod?	Preferred MFA method (device methods only, excludes 'backup')
mfaExempt	boolean	Whether user is exempt from MFA requirements
mfaExemptReason	string | null	Reason for MFA exemption (if exempt)
mfaExemptGrantedAt	Date | string | null	Timestamp when exemption was granted (if exempt)

Example

{
  "enabled": true,
  "required": true,
  "methods": ["totp", "sms"],
  "availableMethods": ["totp", "sms", "backup"],
  "hasBackupCodes": true,
  "preferredMethod": "totp",
  "mfaExempt": false,
  "mfaExemptReason": null,
  "mfaExemptGrantedAt": null
}

Related Types

• MFAMethod - All MFA methods (includes 'backup')
• MFADeviceMethod - Device MFA methods only (excludes 'backup')
• MFADevice - Individual MFA device information

Used By

• NAuthClient.getMfaStatus() - Returns MFAStatus
• Angular AuthService.getMfaStatus() - Observable wrapper
• MFA Setup Guide - MFA configuration guide