Skip to main content

GetAvailableMethodsDTO

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

Data transfer objects for getting available MFA methods that can be set up for a user.

import { GetAvailableMethodsDTO, GetAvailableMethodsResponseDTO } from '@nauth-toolkit/nestjs';

GetAvailableMethodsDTO (Request)

PropertyTypeRequiredDescription
substringYesUser sub. UUID v4 format. Trimmed and lowercased.

GetAvailableMethodsResponseDTO (Response)

PropertyTypeDescription
availableMethodsstring[]Array of available method names.

Example

{
"sub": "a21b654c-2746-4168-acee-c175083a65cd"
}

Response:

{
"availableMethods": ["totp", "sms", "passkey", "email"]
}

Used By