Update User

Update an Auth0 user's attributes.

Options

Field Definition Type Required
Pass Empty Values?

Specifies whether empty values are passed to the remote system, instead of skipping an update to the field.

  • Yes: For any input field on the card that is blank or given a null value, the update includes the empty field. This clears any existing value on the remote system for that field.
  • No: For any input field on the card that is blank or given a null value, nothing is sent to the remote system for this field. Any existing value on the remote system remains unchanged.

This option also affects lists or objects, but doesn't affect dropdown types.

Dropdown

TRUE

Input

If you update the Email, Email Verified, Phone Number, Phone Verified, Username, or Password fields for a secondary identity, you need to specify the Connection field.

Field Definition Type Required
User
ID

Unique identifier of the user.

Text TRUE
User Fields
Name Name of the user. Text FALSE
Email Verified Indicates whether this email address is verified or unverified.

The user receives a verification email after creation if this is false or not specified.

Updating this option isn't supported for Enterprise or Passwordless SMS connections.

True/False FALSE
Phone Verified Indicates whether this phone number is verified or unverified.

This input is only available if you select the Passwordless - SMS option.

True/False FALSE
Username Username of the user.

This field is valid only if the connection requires a username input.

Text FALSE
Given Name Given name of the user. Text FALSE
App Metadata Custom fields that store information about a user. These fields do influence the user's account access. For example, the user's support plan, security roles (if you aren't using Auth0 Authorization Core features), or access control groups.

For more details on metadata storage, see Understand How Metadata Works in User Profiles.

This input doesn't require a specific format.

Updating this metadata merges the existing and new content instead of replacing existing content.

Object FALSE
Metadata Custom fields that store information about a user. These fields don't impact the user 's account access. For example, the user's work address, home address, or other preferences.

For more details on metadata storage, see Understand How Metadata Works in User Profiles.

This input doesn't require a specific format.

Updating this metadata merges the existing and new content instead of replacing existing content.

Object FALSE
Email The email address of the user.

If updating this option, you can optionally specify the Client ID property.

Text FALSE
Family Name Last name of the user. Text FALSE
Nickname Nickname of the user. Text FALSE
Blocked Indicates whether an administrator has blocked this user or not.

Updating this option to false doesn't change the state if the user is blocked due to an excessive number of incorrect credentials. In this case, see Unblock a user who was automatically blocked.

True/False FALSE
Picture A uniform resource identifier (URI) containing the user's picture.

For example, https://www.akc.org/wp-content/uploads/2017/11/Pomeranian-On-White-01.jpg

Text FALSE
Verify Email Indicates whether Auth0 sends the use a verification email after creating the account (true), or not (false).

This overrides the behavior set by the Email Verified input.

True/False FALSE
Phone Number The user's phone number.

The number format must follow the globalized E.164 recommendation of 12 characters, including the region code and area code. For example, +15559876543.

This input is only available if you select the Passwordless - SMS option.

If updating this option, you can optionally specify the Client ID property.

Text FALSE
Password Initial password for the user account. Text FALSE
Client ID The Client ID associated with the Auth0 application. Text FALSE
Connection The name of the connection where this user should be updated.

The card fetches the available choices dynamically from the Auth0 API.

Dropdown FALSE

Output

Field Definition Type
User
Raw Output The raw response object returned by the API after updating the user. Object
ID Unique external ID of the user. Text
Email The email address of the user. Text
Email Verified Indicates whether this email address is verified or unverified.

The user receives a verification email after creation if this is false or not specified.

True/False
Username Username of the user. Text
Phone Number The user's phone number.

This output value only appears for users with SMS connections.

Text
Phone Verified Indicates whether this phone number is verified or unverified. True/False
Created At A timestamp indicating when the user profile was initially created. Text
Updated At A timestamp indicating when the user's profile was most recently updated or modified.

Changes to Last Login are considered updates, so most of the time, Updated At matches Last Login.

Text
Identities Contains information retrieved from the Identity Provider that originally authenticates the user. List of Objects
Connection Name of the Auth0 connection used to authenticate the user. Text
User ID User's unique ID for this connection or provider. Text
Provider Name of the entity that authenticated the user. For example, Facebook, Google, SAML, or your own provider. Text
Is Social Indicates whether the connection is authenticated through a social provider. True/False
App Metadata Data related to the user that does affect the application's core functionality. Object
Metadata Data related to the user that doesn't affect the application's core functionality. Object
Picture A uniform resource identifier (URI) containing the user's picture.

For example, https://www.akc.org/wp-content/uploads/2017/11/Pomeranian-On-White-01.jpg

Text
Name Name of the user. Text
Nickname Nickname of the user. Text
Multifactor List of multifactor providers where the user is enrolled. List of Objects
Last IP IP address associated with the user's last sign-in attempt. Text
Last Login A timestamp indicating when the user last signed in. Text
Logins Count Number of times the user has signed in. Number
Blocked Indicates whether an administrator has blocked this user or not. True/False
Given Name Given name of the user. Text
Family Name Last name of the user. Text

Related topics

Auth0 connector

Workflow elements

Auth0 Management API Access Tokens

Auth0 Management API