Skip to main content

AdminUpdateUserAttributesDTO

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

Data transfer objects for admin-initiated user profile updates. Extends UserUpdateDTO with required sub field.

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

AdminUpdateUserAttributesDTO (Request)

PropertyTypeRequiredDescription
substringYesUser sub (UUID v4). Trimmed, lowercased for consistency.
usernamestringNoUsername. 3-255 characters. Alphanumeric, underscores, and hyphens only.
firstNamestringNoFirst name. 1-100 characters. Trimmed.
lastNamestringNoLast name. 1-100 characters. Trimmed.
emailstringNoEmail address. Valid email format.
phonestringNoPhone number. E.164 format.
metadataobjectNoCustom metadata. Merged with existing metadata. Set key to null to delete.
preferredMfaMethodstringNoPreferred MFA method. One of: totp, sms, email, passkey.
retainVerificationbooleanNoWhether to retain email/phone verification status when updating email/phone. Default: false.

UserResponseDTO (Response)

Returns the updated user object. See UserResponseDTO for full structure.

Example

{
"sub": "a21b654c-2746-4168-acee-c175083a65cd",
"username": "newusername",
"firstName": "John",
"lastName": "Doe",
"metadata": {
"department": "Engineering",
"role": "Senior Developer"
}
}

Used By