User Profile Structure
Auth0's normalized user profile consists of a few different components:
Details: Core User Profile object, which contains basic info, such as name, email, and timestamp of the user's latest login, in pre-defined attributes. This object may also contain info from a user's source connection. Most of the user attributes are root attributes (attributes stored at the first, or root, level of the
userobject), and some of these are editable.
Metadata: Two sub-objects that operate as secondary storage to store additional user info in customizable attributes:
app_metadata. To learn more, including when to use
user_metadata, read Understand How Metadata Works in User Profiles.
User profile attributes
The following attributes are available on the user profile. Many are root attributes (attributes stored at the first, or root, level of the
user object), and some may be updated, imported, and exported, as noted below.
If there are user fields that should not be stored by Auth0 due to privacy reasons, you can add the attributes you do not want persisting in Auth0 databases to the DenyList. To learn more, read Add User Attributes to the DenyList.
By default, user profile attributes provided by identity providers other than Auth0 (such as Google, Facebook, Twitter) are not directly editable because they are updated from the identity provider each time the user logs in.
To be able to edit the
picture root attributes on the normalized user profile, you must configure your connection sync with Auth0 so that user attributes will be updated from the identity provider only on user profile creation. These root attributes will then be available to be edited individually or by bulk imports
|Name||Type||Description||Search?||Update?||Import?||Upsert during import?||Export?|
||object||Custom fields that store info about a user that influences the user's access, such as support plan, security roles (if not using the Authorization Core feature set), or access control groups. To learn more, read Metadata Overview.||Y||Y||Y||Y||Y|
||boolean||Indicates whether the user has been blocked. Importing enables subscribers to ensure that users remain blocked when migrating to Auth0.||Y||Y||Y||N||Y|
||date time||Timestamp indicating when the user profile was first created.||Y||N||N||N||Y|
|text||(unique) The user's email address.||Y||Y||Y||N||Y|
||boolean||Indicates whether the user has verified their email address.||Y||Y||Y||Y||Y|
||text||The user's family name.||Y||Y||Y||Y||Y|
||text||The user's given name.||Y||Y||Y||Y||Y|
||object||Custom fields that store info about a user that does not impact what they can or cannot access, such as work address, home address, or user preferences. To learn more, read Metadata Overview.||Y||Y||Y||Y||Y|
||text||(unique) The user's username.||Y||Y||Y||N||Y|
Contains info retrieved from the identity provider with which the user originally authenticates. Users may also link their profile to multiple identity providers; those identities will then also appear in this array. The contents of an individual identity provider object varies by provider, but it will typically include the following:
||text||IP address associated with the user's last login.||Y||N||N||N||Y|
||date time||Timestamp indicating when the user last logged in. If a user is blocked and logs in, the blocked session updates
||date time||Timestamp indicating the last time the user's password was reset/changed. At user creation, this field does not exist. This property is only available for Database connections.||N||N||N||N||N|
||integer||Number of times the user has logged in. If a user is blocked and logs in, the blocked session is counted in
||text||List of multi-factor providers with which the user is enrolled.||N||N||N||N||Y|
||text||The user's full name.||Y||Y||Y||Y||Y|
||text||The user's nickname.||Y||Y||Y||Y||Y|
||text||The user's phone number. Only valid for users with SMS connections.||Y||Y||N||N||Y|
||boolean||Indicates whether the user has been verified their phone number. Only valid for users with SMS connections.||Y||Y||N||N||Y|
||text||URL pointing to the user's profile picture.||N||Y||Y||Y||Y|
||date time||Timestamp indicating when the user's profile was last updated/modified. Changes to
||text||(unique) The user's identifier. Importing allows user records to be synchronized across multiple systems without using mapping tables.||Y||N||Y||N||Y|
Three other fields are not technically part of the user profile, but may be of interest when importing users:
password_hash(text): Hashed password for the user's connection. When users are created, Auth0 uses bcrypt to secure the password. Importing compatible hashed passwords allows users to retain their passwords, thereby providing a smoother experience. Compatible passwords should be hashed using bcrypt $2a$ or $2b$ and have 10 saltRounds. Note that you can provide this field only when the user is first imported; you cannot update it later.
custom_password_hash(object): Hashed password for the user's connection when created using an alternate algorithm. Used in place of the
password_hashfield. During the bulk import process, you can update the
custom_password_hashif the user did not login using the initially imported
password_set_date(date time): Timestamp indicating when the password for the user's connection was set. At user creation, this field exists, and
last_password_resetdoes not. If the user has reset their password, this field and