Activate and Configure Attributes for Flexible Identifiers
Enabling Flexible Identifiers on your tenant has the potential to introduce breaking changes to your production environment. For more information on potential problems and limitations, see Flexible Identifiers and Attributes.
Activate attributes configuration
Navigate to Auth0 Dashboard > Authentication > Database, then select the Database Connection you’d like to activate from the list of Database Connections.
Go to the Attributes tab and choose Activate on the New Attributes Configuration screen, then confirm you’ve tested your configuration in a Development environment.
Select Proceed. The new configuration options become available.
Choose Attributes on a new connection
Attributes are added to connections by navigating to Auth0 Dashboard > Authentication > Database.
To create a new connection, choose + Create DB Connection and pick which Attributes to add. To add, configure, or remove Attributes in use by an existing connection, configure an existing connection, choose the Attributes tab and follow the instructions below.
Default values are assigned to a new connection and can be edited after the connection has been created.
| Setting | Value |
|---|---|
Use {attribute} as Identifier |
True |
Allow Signup with {attribute} |
Required |
Require {attribute} on user profile |
True |
| Username Length | Min: 1 Max: 15 |
| Allow usernames in email format | False |
| Allow usernames in phone number format | False |
Add Attributes to an existing connection
Navigate to the Attributes tab and choose Activate, then choose from the available Attributes and select the Create option.
Available Attributes and Configuration Options for Email Identifier
| Option | |
|---|---|
| Use Email as Identifier | Turning this on will make email an identifier for this connection. Users will be able to use email for login and password reset. |
| Allow Signup with Email | Choose how email will be collected at signup
Signup flows include:
|
| Verify email on sign up | Users will be asked to verify their email address via magic link when signing up. |
| Require email on user profile | Requires email to be present across all operations that create or update a user profile on this connection. Will require email is present on the following:
|
Available Attributes and Configuration Options for Phone Identifier
| Option | |
|---|---|
| Use Phone as Identifier | Turning this on will make phone_number an identifier for this connection. Users will be able to use phone_number for login and password reset. |
| Allow Signup with Phone | Choose how the phone number will be collected at signup
Signup flows include:
|
| Verify phone on signup | Users will be required to verify their phone number via OTP when signing up. Please ensure you have configured a phone provider or your users will not be able to proceed with signing up. |
| Require phone on user profile | Requires phone to be present across all operations that create or update a user profile on this connection. Will require phone is present on the following:
|
Available Attributes and Configuration Options for Username Identifier
| Option | |
|---|---|
| Use Username as Identifier | Turning this on will make username an identifier for this connection. Users will be able to use username for login and password reset. |
| Allow Signup with Username | Choose how the username will be collected at signup
Signup flows include:
|
| Require username on user profile | Requires username to be present across all operations that create or update a user profile on this connection. Will require username is present on the following:
|
| Username Length | Set the minimum and maximum values allowed for a user to have as username. |
Configure or remove existing Attributes on a connection
All Attributes can be changed or deleted from your Auth0 Dashboard. Users cannot log in, sign up or reset passwords using the removed Attribute, and a minimum of one Attribute must remain active on every connection.
To change or remove an Attribute, navigate to the Attributes tab, then choose the ... menu button next to an Attribute and select Configure or Remove from the dropdown menu.
Revert a connection
If your tenant has username enabled as an Attribute, performing the following action requires you to modify your username settings. You'll need to reconfigure your username settings if you choose this path.
To revert a connection back to its original state, use the Management API to PATCH the connection endpoint /api/v2/connections/:id with an empty options object like the example below.
{
"options": {
}
}Was this helpful?