SetMFAExemptionDTO

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

Data transfer objects for granting or revoking a user's exemption from multi-factor authentication requirements.

NestJS

import { SetMFAExemptionDTO, SetMFAExemptionResponseDTO } from '@nauth-toolkit/nestjs';

Express

import { SetMFAExemptionDTO, SetMFAExemptionResponseDTO } from '@nauth-toolkit/core';

Fastify

import { SetMFAExemptionDTO, SetMFAExemptionResponseDTO } from '@nauth-toolkit/core';

SetMFAExemptionDTO (Request)

Property	Type	Required	Description
sub	string	Yes	User sub (UUID v4). Trimmed and lowercased.
exempt	boolean	Yes	Grant exemption (true) or revoke exemption (false).
reason	string | null	No	Reason for exemption status change. Max 500 characters. Trimmed.
grantedBy	string | null	No	Identifier of admin performing action. Max 255 characters. Trimmed.

SetMFAExemptionResponseDTO (Response)

Property	Type	Description
mfaExempt	boolean	Whether user is exempt.
mfaExemptReason	string | null	Reason for exemption.
mfaExemptGrantedAt	Date | null	Date exemption was granted.

Example

{
  "sub": "a21b654c-2746-4168-acee-c175083a65cd",
  "exempt": true,
  "reason": "Business partner requires MFA bypass",
  "grantedBy": "admin@example.com"
}

Response:

{
  "mfaExempt": true,
  "mfaExemptReason": "Business partner requires MFA bypass",
  "mfaExemptGrantedAt": "2024-01-01T00:00:00.000Z"
}

Used By

• MFAService.setMFAExemption()