Skip to main content

GetSetupDataResponseDTO

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

Response data transfer object for MFA setup data (structure varies by method).

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

Properties

PropertyTypeDescription
setupDataRecord<string, unknown>Provider-specific setup data. Structure varies by method: TOTP returns secret, qrCode, manualEntryKey; SMS returns maskedPhone; Email returns maskedEmail; Passkey returns WebAuthn registration options.

Example

TOTP:

{
"setupData": {
"secret": "JBSWY3DPEHPK3PXP",
"qrCode": "data:image/png;base64,...",
"manualEntryKey": "JBSWY3DPEHPK3PXP"
}
}

SMS:

{
"setupData": {
"maskedPhone": "***-***-7890"
}
}

Used By