AuthUser

Package: @nauth-toolkit/client Type: Response

Complete user profile returned from profile endpoints. Includes authentication status, MFA configuration, and account metadata.

import { AuthUser } from '@nauth-toolkit/client';

Properties

Property	Type	Description
id	number	Internal user ID
sub	string	User subject identifier (public ID)
email	string	User email address
firstName	string | null	User first name
lastName	string | null	User last name
phone	string | null	Phone number in E.164 format (e.g., +14155551234)
isEmailVerified	boolean	Whether email is verified
isPhoneVerified	boolean	Whether phone is verified
mfaEnabled	boolean	Whether MFA is enabled
preferredMfaMethod	string | null	Preferred MFA method ('sms', 'email', 'totp', 'passkey')
socialProviders	string[]	Linked social auth providers (e.g., ['google', 'apple'])
hasPasswordHash	boolean	Whether user has a password set
sessionAuthMethod	string | null	How the current session was authenticated (password, google, apple, facebook)
isActive	boolean	Whether account is active
createdAt	Date	Account creation timestamp
updatedAt	Date	Last update timestamp

Example

{
  "id": 123,
  "sub": "user_abc123",
  "email": "user@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+14155551234",
  "isEmailVerified": true,
  "isPhoneVerified": true,
  "mfaEnabled": true,
  "preferredMfaMethod": "totp",
  "socialProviders": ["google"],
  "hasPasswordHash": true,
  "sessionAuthMethod": "google",
  "isActive": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-15T12:30:00.000Z"
}

Related Types

• AuthUserSummary - Minimal user info in AuthResponse
• UpdateProfileRequest - Profile update payload
• AuthResponse - Authentication response containing user

Used By

• NAuthClient.getProfile() - Returns AuthUser
• NAuthClient.updateProfile() - Accepts UpdateProfileRequest, returns AuthUser
• NAuthClient.getCurrentUser() - Returns AuthUser or null
• Angular AuthService.getProfile() - Observable wrapper
• Angular AuthService.updateProfile() - Observable wrapper
• Angular AuthService.getCurrentUser() - Sync accessor