AuthResponseUser
Package: @nauth-toolkit/core
Type: Interface
User information interface returned in authentication responses. Contains only essential fields needed for client applications, excluding sensitive and internal data.
- NestJS
- Express
- Fastify
import { AuthResponseUser } from '@nauth-toolkit/nestjs';
import { AuthResponseUser } from '@nauth-toolkit/core';
import { AuthResponseUser } from '@nauth-toolkit/core';
Properties
| Property | Type | Required | Description |
|---|---|---|---|
sub | string | Yes | User identifier (UUID v4). External identifier safe to expose. |
email | string | Yes | User's email address. |
firstName | string | null | No | User's first name. |
lastName | string | null | No | User's last name. |
phone | string | No | Phone number in E.164 format. |
isEmailVerified | boolean | Yes | Email verification status. |
isPhoneVerified | boolean | No | Phone verification status. |
socialProviders | string[] | No | Array of linked social providers (e.g., ['google', 'apple']). |
hasPasswordHash | boolean | No | Whether user has a password set. Used to determine authentication capabilities. |
Used By
- AuthResponseDTO -
userproperty type - toAuthResponseUser() - Conversion utility function
Related APIs
- IUser - Full user entity interface
- UserResponseDto - Complete user response DTO