GetMFAStatusResponseDTO

Package: @nauth-toolkit/core Type: DTO (Response)

Response DTO for getting comprehensive MFA status for a user.

NestJS

import { GetMFAStatusResponseDTO } from '@nauth-toolkit/nestjs';

Express

import { GetMFAStatusResponseDTO } from '@nauth-toolkit/core';

Fastify

import { GetMFAStatusResponseDTO } from '@nauth-toolkit/core';

Properties

Property	Type	Description
enabled	boolean	Whether MFA is enabled.
required	boolean	Whether MFA is required.
configuredMethods	Array<MFADeviceMethod>	Array of configured device methods.
availableMethods	Array<string>	Array of available method names.
hasBackupCodes	boolean	Whether user has backup codes.
preferredMethod	MFADeviceMethod?	Preferred MFA method (if set).
mfaExempt	boolean	Whether user is exempt from MFA.
mfaExemptReason	string | null	Reason for exemption (if exempt).
mfaExemptGrantedAt	Date | null	Date exemption was granted (if exempt).

Example

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

Used By

• MFAService.getMfaStatus() - User self-service method
• MFAService.adminGetMfaStatus() - Admin operation

Related APIs

• AdminGetMFAStatusDTO - Admin request DTO (requires sub)