Skip to main content

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.

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

Properties

PropertyTypeRequiredDescription
substringYesUser identifier (UUID v4). External identifier safe to expose.
emailstringYesUser's email address.
firstNamestring | nullNoUser's first name.
lastNamestring | nullNoUser's last name.
phonestringNoPhone number in E.164 format.
isEmailVerifiedbooleanYesEmail verification status.
isPhoneVerifiedbooleanNoPhone verification status.
socialProvidersstring[]NoArray of linked social providers (e.g., ['google', 'apple']).
hasPasswordHashbooleanNoWhether user has a password set. Used to determine authentication capabilities.

Used By