UserResponseDTO

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

Sanitized user object for API responses. Excludes all sensitive and internal fields.

NestJS

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

Express

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

Fastify

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

Properties

Property	Type	Required	Description
sub	string	Yes	User identifier (UUID v4).
email	string	Yes	Email address.
username	string | null	No	Username (optional).
firstName	string | null	No	First name (optional).
lastName	string | null	No	Last name (optional).
phone	string | null	No	Phone number in E.164 format (optional).
isEmailVerified	boolean	Yes	Email verification status.
isPhoneVerified	boolean	Yes	Phone verification status.
isActive	boolean	Yes	Account active status.
isLocked	boolean	Yes	Whether the account is locked.
mfaEnabled	boolean	Yes	MFA enabled status.
mfaExempt	boolean	Yes	Whether the user is exempt from MFA requirements.
socialProviders	string[] | null	No	Linked social providers (optional).
hasPasswordHash	boolean	Yes	Whether user has password set.
createdAt	Date	Yes	Account creation timestamp.
updatedAt	Date	Yes	Last account update timestamp.

Example

{
  "sub": "a21b654c-2746-4168-acee-c175083a65cd",
  "email": "user@example.com",
  "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+14155552671",
  "isEmailVerified": true,
  "isPhoneVerified": true,
  "isActive": true,
  "isLocked": false,
  "mfaEnabled": false,
  "mfaExempt": false,
  "socialProviders": ["google"],
  "hasPasswordHash": true,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-15T12:00:00.000Z"
}

Used By

• AdminAuthService.getUserById()
• AdminAuthService.getUserByEmail()
• AuthService.updateUserAttributes()