Prerequisites for Bulk Users Import

Knowledge Articles
, ,
1

Overview

This article presents what is needed before a Bulk User Import.

Applies To

  • ​​​​​​​Bulk User Import
  • Prerequisites

Solution

Bulk user data can be imported into Auth0 using the Create Import Users Job endpoint. This is useful for migrating users from an existing database or service to Auth0.

Prerequisites:

  • Configure a database connection to import the users into and enable it for at least one application.
  • If importing passwords, make sure the passwords are hashed using one of the supported algorithms. Users with passwords hashed by unsupported algorithms will need to reset their password when they log in for the first time after the bulk import.
  • If importing MFA enrollments, ensure they are a supported type: email, phone, or TOTP.
  • Get a Management API token for job endpoint requests.

The Create Import Users Job endpoint can only process two concurrent import jobs. Requesting additional jobs while there are two pending returns a 429 Too Many Requests response.

There are two ways to estimate an approximate time to finish the import:

  • If the release tenant is currently on the free bulk import tier (because it has the staging environment tag), in typical scenarios, we have observed that the bulk import throughput at the enterprise tier is around 10X faster than at the free tier. So, benchmark with a subset of the imports and multiply by 10 to get an estimate.
  • If it is desired to benchmark the bulk import duration on the enterprise tier, it still can be done with a small subset of the import in the prod tenant if it’s set on the enterprise tier.

In both cases, these are estimates only, and the final result will depend on the traffic in the environment at the time they run it.

Related References