Export Users using the User Export API
Export users from your project into a CSV or JSON file
The Export User API offers a means for exporting user data such as user ID, email, phone number, etc from your Authgear project into a CSV or ndjson file.
In this guide, you'll learn how to use the User Export API.
User Export API
The User Export API allows developers to bulk export users into a file.
The export process is asynchronous. That is, the process runs in the background. Hence, you will need to initiate an export task in one endpoint call and then, make an additional call to another endpoint to get the status of the export task.
Authentication
To use the Export User API, your application must be authenticated using an Admin API JWT token.
Once you obtain a valid Admin API JWT, you can set it as a Bearer Authorization header to access the Export User API Endpoints. The API will return a "403 Forbidden" error if an invalid JWT is used.
The following are the two endpoints for the User Export API:
Initiate Export Task
POST
/_api/admin/users/export
Use this endpoint to create a new user export task.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Host |
|
Body
The Initiate Export endpoint accepts JSON input via an HTTP(S) request body. The following is an example of the input:
The
format
field is where you specify the format of the export file. The value can becsv
orndjson
.csv
: use this field whenformat
is set tocsv
. The value is an object with afields
property.csv.fields
: you can use this field to list all the user attributes you want to include as fields in the CSV file. The value should be an array and each item in the array is an object with apointer
and an optionalfield_name
property that describe a user attribute.
User Profile Attribute Pointers
The following is a complete list of supported pointers:
Pointer | Description | Value |
---|---|---|
|
| String |
| the user's chosen username. | String |
| the email address associated with the current user account | String |
| a phone number associated with the current user's account | String |
| contains a boolean value that represents the current status of the user's email verification. The value can be either | Boolean |
| returns | Boolean |
| the user's display name. | String |
| the user's given name | String |
| the user's middle name | String |
| a nickname set by the user. | String |
| link to the user's profile | String |
| contains the URL to the user's profile photo. | String |
| the user's website. That is, the value a user sets in the website attribute for their profile. | String |
| holds the value set for the current users' gender (male, female, or some other string). | String |
| the user's birthday set in their profile's standard attribute. | String |
| the user's timezone. For example | String |
| display language set by user. For example | String |
| the value the user sets for the street address field in their address standard attribute. | String |
| the value the user sets for the city (locality) field in their address standard attribute. | String |
| the value the user sets for the "State / Province / Prefecture / Region" field in their address standard attribute. | String |
| the postcode in the user's address standard attribute. | String |
| the value the user sets for the country field in their address standard attribute. | String |
| a list of all the roles assigned to the current user. | Array |
| a list of all the access management groups the user has been added to. | Array |
| the status of the user's account. The value is | Boolean |
| a list of all the identities associated with a user's account. The structure of the value looks like this:
| Array |
| a list of email addresses the user has added to receive 2FA login link or OTP. | Array |
| a list of phone numbers the user has added to receive OTP via SMS or WhatsApp. | Array |
| a list of JSON objects that contain details such as secret and uri for TOTP. The following an example of the struture of the data in this field:
| Array |
| number of of biometric registered for the user. | Integer |
| number of passkey registered for the user. | Integer |
If csv.fields
is not specified, all the above pointers will be included as fields in the exported CSV file.
The value for pointer
for a custom attribute will follow this format:
For example, a custom attribute named member_id
will be {"pointer": "/custom_attributes/member_id"}
.
If field_name
is not given, then it is derived from pointer
using the following rules:
Let
parts
be the list of the reference tokens inpointer
.Join
parts
with the character.
.
For example, following the above roles, the derived field_name for {"pointer": "/address/formatted"}
will be address.formatted
.
Response
The body of an HTTP(S) request to the Initiate Export endpoint looks like this:
id
: the value for this field is the export task ID required in the check status endpoint.created_at
: contains the date and time an export task was created.status
: returnspending
when the task is created successfully.
Error Response
Description | Name | Reason | Info |
---|---|---|---|
When user export is disabled |
|
| - |
When the rate limit exceeded |
|
| {"bucket_name": "UserExport"} |
When there is a running export |
|
| - |
When the input fails the validation |
|
| The info should contain the JSON schema validation output |
When the field names are not unique |
|
| Output the full list of "field_names". Like |
Check Status
GET
/_api/admin/users/export/{Task ID}
Use this endpoint to query the status of an existing export task. Replace {Task ID}
with the task id
returned in the response body of the initiate export endpoint.
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Host |
|
Response
The following is what the response body of the Check Status endpoint looks like:
The
status
field reports progress on the current export task. If the value iscompleted
, the export is complete, and you can now download the export file.download_url
: This is a signed URL that you can use to download the export file.
Note: The result from a completed export task will expire after 24 hours. Hence, after 24 hours, you can no longer use the task ID associated with the task to generate a new download link.
Error Response
Description | Name | Reason | Info |
---|---|---|---|
When user export is disabled |
|
| - |
When the given ID does not refer to an export |
|
| - |
Download Export File
The response of the check status endpoint will include a download_url
field that contains a signed URL that you can open to download the CSV or ndjson user export file.
The signed URL is only valid for 60 seconds, and afterwards, you'll have to make another request to the check status endpoint using the task ID to obtain a new URL.
Example: Using the User Export API
The following example shows how to use the User Export API in a Node.js application.
Step 1: Get Admin API JWT
First, you need to get the Admin API JWT that will be used to authenticate requests to the endpoints.
To do that, install JsonWebToken (a Node package for generating JWT) by running the following command:
Now, create a generateJWT()
function in your Express app to generate the JWT:
See Admin API Authentication for a more detailed guide on how to get your key ID, and private key and generate Admin API JWT using different programming languages.
Step 2: Initiate User Export Task
Make an HTTP(S) POST request to the initiate export endpoint. To do that, first, install the node-fetch package in your app using this command:
Then add the following code to your application:
Step 3: Check the Status of a User Export Task
In this step, we'll check the status of the export task we initiated by making an HTTP(S) request to the Check Status endpoint.
Add the following route to your app to check the status of an export task using the task ID:
When the status task is completed, the HTTP(S) response body will contain a download_url
field. Open the URL in the value of download_url
to download the exported users file.
Last updated