Skip to main content

LoginDTO

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

Data transfer object for user login requests. Supports email, username, or phone number as identifier.

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

Properties

PropertyTypeRequiredDescription
deviceNamestringNoHuman-readable device name (e.g., "John's iPhone"). Max 255 characters.
deviceType'mobile' | 'desktop' | 'tablet'NoDevice type for session categorization. Must be mobile, desktop, or tablet. Lowercased.
identifierstringYesEmail, username, or phone number. Auto-detects type. 1-255 characters.
passwordstringYesUser password. 1-128 characters. Not trimmed.
recaptchaTokenstringNoreCAPTCHA token from client. Required when reCAPTCHA is enforced. See reCAPTCHA Guide.

Example

{
"identifier": "user@example.com",
"password": "SecurePass123!",
"deviceName": "John's iPhone 15",
"deviceType": "mobile",
"recaptchaToken": "03AGdBq25..."
}

Used By