docs/interfaces/management.Management.UpdateUserRequestContent.html
{}Copy
interface UpdateUserRequestContent {
blocked?: boolean;
email_verified?: boolean;
email?: string | null;
phone_number?: string | null;
phone_verified?: boolean;
user_metadata?: UserMetadata;
app_metadata?: AppMetadata;
given_name?: string | null;
family_name?: string | null;
name?: string | null;
nickname?: string | null;
picture?: string | null;
verify_email?: boolean;
verify_phone_number?: boolean;
password?: string | null;
connection?: string;
client_id?: string;
username?: string | null;
}
blocked?email_verified?email?phone_number?phone_verified?user_metadata?app_metadata?given_name?family_name?name?nickname?picture?verify_email?verify_phone_number?password?connection?client_id?username?
Optionalblockedblocked?: boolean
Whether this user was blocked by an administrator (true) or not (false).
Optionalemail_verifiedemail_verified?: boolean
Whether this email address is verified (true) or unverified (false). If set to false the user will not receive a verification email unless verify_email is set to true.
Optionalemailemail?: string | null
Email address of this user.
Optionalphone_numberphone_number?: string | null
The user's phone number (following the E.164 recommendation).
Optionalphone_verifiedphone_verified?: boolean
Whether this phone number has been verified (true) or not (false).
Optionaluser_metadatauser_metadata?: UserMetadata
User metadata to which this user has read/write access.
Optionalapp_metadataapp_metadata?: AppMetadata
User metadata to which this user has read-only access.
Optionalgiven_namegiven_name?: string | null
Given name/first name/forename of this user.
Optionalfamily_namefamily_name?: string | null
Family name/last name/surname of this user.
Optionalnamename?: string | null
Name of this user.
Optionalnicknamenickname?: string | null
Preferred nickname or alias of this user.
Optionalpicturepicture?: string | null
URL to picture, photo, or avatar of this user.
Optionalverify_emailverify_email?: boolean
Whether this user will receive a verification email after creation (true) or no email (false). Overrides behavior of email_verified parameter.
Optionalverify_phone_numberverify_phone_number?: boolean
Whether this user will receive a text after changing the phone number (true) or no text (false). Only valid when changing phone number for SMS connections.
Optionalpasswordpassword?: string | null
New password for this user. Only valid for database connections.
Optionalconnectionconnection?: string
Name of the connection to target for this user update.
Optionalclient_idclient_id?: string
Auth0 client ID. Only valid when updating email address.
Optionalusernameusername?: string | null
The user's username. Only valid if the connection requires a username.
Member Visibility
ThemeOSLightDark
Properties blockedemail_verifiedemailphone_numberphone_verifieduser_metadataapp_metadatagiven_namefamily_namenamenicknamepictureverify_emailverify_phone_numberpasswordconnectionclient_idusername