UserUpdateDTO

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

Data transfer object for updating user profile attributes with optional fields and validation.

NestJS

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

Express

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

Fastify

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

Properties

Property	Type	Required	Description
username	string	No	Username. 3-255 characters. Alphanumeric, underscores, hyphens only. Trimmed.
firstName	string	No	First name. 1-100 characters. Trimmed.
lastName	string	No	Last name. 1-100 characters. Trimmed.
email	string	No	Email address. Valid email format. Max 255 characters. Trimmed and lowercased.
phone	string	No	Phone number. E.164 format (e.g., +14155552671). Max 20 characters. Whitespace removed.
locale	string	No	BCP 47 locale (e.g. en-GB). Rejected if not a valid tag. Max 35 characters.
metadata	Record<string, unknown>	No	Custom metadata fields. Merged with existing metadata. Set key to null to delete.
timezone	string	No	IANA timezone (e.g. Europe/Dublin). Rejected if unknown to the runtime. Max 64 chars.
preferredMfaMethod	MFADeviceMethod	No	Preferred MFA method. Must be: totp, sms, email, passkey. Max 50 characters.

retainVerification is not part of this base DTO. It is an administrator-only field defined on AdminUpdateUserAttributesDto. Self-service email/phone changes always reset the corresponding verification flag.

Metadata Behavior

The metadata field supports merge and delete operations:

• Add/Update: Provide key-value pairs to add or update
• Delete: Set a key to null to remove it from metadata
• Merge: Existing metadata is preserved unless explicitly updated or deleted

Examples

Basic Update

{
  "username": "johndoe",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "phone": "+14155552671",
  "preferredMfaMethod": "totp"
}

Adding/Updating Metadata

{
  "metadata": {
    "department": "Engineering",
    "role": "Senior Developer"
  }
}

Deleting Metadata Keys

{
  "metadata": {
    "temporaryField": null,
    "oldKey": null
  }
}

Mixing Metadata Operations

{
  "firstName": "Jane",
  "metadata": {
    "department": "Product",
    "role": "Product Manager",
    "oldDepartment": null
  }
}

Used By

• UpdateUserAttributesDTO - Extends this DTO
• AdminUpdateUserAttributesDTO - Extends this DTO (admin)
• AuthService.updateUserAttributes()