Docs

Bulk User Exports

You can use the POST /api/v2/jobs/users-exports endpoint to create a job that exports all users associated with a connection.

For a list of user profile fields that can be exported, see User Profile Attributes.

When you create your job, you'll need to provide:

  • ID for the connection whose users you want exported
  • Format of the export file (CSV or JSON-compatible)
  • Maximum number of user records to be exported (optional, will export all records if omitted)
  • User-related fields (such as user ID or name) that you want included in the export

Prerequisite

To use the user search endpoints, you'll need to obtain a valid Access Token and provide it in the header of your call (replace the YOUR_MGMT_API_ACCESS_TOKEN placeholder value).

Syntax

Required Scopes: read:users




Sample results

Include user metadata

CSV format

If you export user data in CSV format and want to include metadata information, specify each metadata field that you want to include.

For example, for metadata structured like this:

The export request (for all three fields) will looks like this:




JSON-compatible format

If you export the data in JSON-compatible format, you only need to provide the root property; you do not need to name each individual inner property since they will be included automatically.

Auth0's export files use the ndjson format due to the large size of the export files, while the import functionality expects a JSON file.

Before you can import users using an export generated by Auth0, you'll need to convert the file from ndjson to json using the library of your choice (such as jq).

In this case, for the same example we used before, the request will look like this:




Check export status

Once you've created your job to export your users, you can check on its status using the Get a Job endpoint.

Provide the ID of the job (which you received in the response when creating the job). If you're using the sample request below, replace the placeholder YOUR_JOB_ID with the value of the ID.

Require Scopes: create:users, read:users, create:passwords_checking_job




Sample results

Find export data

You can access your export files using the URL provided as the value for the location parameter. The name of your tenant is also the name of your file. For example, if your tenant name is auth0docs, then your file will be auth0docs.csv or auth0docs.json. When you navigate to the URL, you will automatically begin downloading the file.

The download link is valid for 60 seconds. If this time period expires, you will need to initiate a new job.

Exported user data

Keep reading