Bulk User Exports
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
- User-related fields (such as user ID or name) that you want included in the export
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).
Include user metadata
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:
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.
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.
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.json. When you navigate to the URL, you will automatically begin downloading the file.