Configure Automatic Migration from Your Database

Configure Automatic Migration from Your Database

After you create a database connection in the Dashboard, you enable user migration from that database and create custom scripts to determine how the migration happens.

These custom scripts are Node.js code that run in the tenant's sandbox. Auth0 provides templates for most common databases, such as: ASP.NET Membership Provider, MongoDB, MySQL, Oracle, PostgreSQL, SQLServer, Windows Azure SQL Database, and for a web service accessed by Basic Auth. For more information on implementing these scripts, see Authenticate Users using a Custom Database.

  1. Navigate to the Connections > Database page in the Auth0 Dashboard, and click Create DB Connection.

Dashboard: Database Connection List

  1. Click the Custom Database tab, and enable the Use my own database option:

Dashboard: Enable Use My Own Database Option

  1. Click the Settings tab, and enable the Import Users to Auth0 option:

Dashboard: Enable Import Users Option

Configure the scripts

  1. Click the Custom Database tab, and locate Database Action Scripts to see the scripts you need to configure.

Dashboard: Configure Database Action Scripts

  • Login: Executes each time a user that is not found in the Auth0 database attempts to log in. Verifies that the user exists in the legacy database without re-prompting the user for their password.

  • Get User: Executes following any of these actions:

Passwords for Un-Migrated Users

If an un-migrated user confirms a password change, their user profile will be created in Auth0 with the new password. This user profile will contain all the information returned in the Get User script. All subsequent logins of this user will be performed in Auth0 directly.

You may see unexpected behavior if you return differing user profiles in the login and get_user scripts.

Verify the migration

After you've enabled migration, you can verify the users that have migrated by doing one or both of the following tasks:

  1. Use the List or search users Management API endpoint.

  2. Navigate to the Users page in the Auth0 Dashboard, and review the list of users.

View Users

Convert the database

Once all your users are in the Auth0 database, you are ready to convert the database to Auth0.

  1. Go to your custom database connection on the Dashboard.

  2. Update the Login Database Action Script to the following:

function login (email, password, callback) {
  return callback(null, null);
  1. Update the Get User Database Action Script to the following:
function getByEmail (email, callback) {
  return callback(null, null);

By doing this, you are changing the Login and Get User Database Action Scripts to NO-OP functions.

Disconnect the legacy database

  1. After you have verified the migration, you can disconnect your legacy database (not the Auth0 database).

  2. Keep Import Users to Auth0 (on the Settings page) enabled. Your users will then be directed to use the new database workflow.

  3. Configure rules to execute other functions when a user authenticates to your application.

Keep reading