To export user data, click the download icon on the Users screen. A pop-up window to download specific user data is displayed. You can choose from one of the following options:

• Attributes
• Extended Profiles
• Foreign Keys
• Grants

Before downloading, you can also filter user records based on the attributes within your tenant and the account details. You can use the filter operators to refine your filters further. You must select the required user store from the list before exporting users based on their User Store.

When you start a user export, a progress indicator appears in the bottom-right corner of the screen. It updates in real time to show how the export is progressing. During the export, you'll see these stages:

• Preparing user export – The system is setting up the export.

• Downloading: X.XMB / Y.YMB - The file is downloading, showing how much data has been transferred and the overall progress.

• Downloading state events - Shown only if your organization has state events export enabled.

• Export complete! or All exports complete! – Confirms that the export has finished successfully.

  Note:

  • Large exports may take several minutes, depending on the number of users and your internet speed.

  • Keep the browser tab open until the export finishes; closing it will cancel the process.

  • The Export button is temporarily disabled during the export to prevent duplicate requests.

Once you export the file, the user records in the exported CSV file will contain the filtered records. Each row within the file corresponds to a subscription purchased by the end user. Comprehensive details regarding both the users and their purchased subscriptions are presented within the data table.

Asynchronous user exports

Zephr supports asynchronous user exports to improve the performance of exporting large user datasets.

When asynchronous export is enabled, export jobs run in the background instead of being processed directly in the browser. This allows exports to continue processing even if you close the browser or navigate away from the page.

After the export completes, the CSV file is stored securely in Amazon S3, and a presigned download URL is generated so that the file can be downloaded.

If the export is initiated from the Admin Console, you receive an email notification when the export succeeds or fails. If the export is initiated using the API, email notifications are not sent.

Asynchronous export is controlled by the, feature.asyncUserExport.enabled, feature flag. When the feature is:

• Enabled - User exports run asynchronously and the exported file is stored in Amazon S3.

• Disabled - The export runs using the existing synchronous export process.

The asynchronous user export provides the following benefits:

• Improves performance for large user exports.

• Allows exports to run in the background.

• Eliminates the need to keep the browser open while the export is processing.

• Provides a secure download link once the export completes.

You can track the status of an export job using the following endpoint:

GET /v4/user-export-jobs/:jobId

This endpoint returns the job status and the download URL when the export is complete.

Error Messages

If something goes wrong, one of these messages appears:

• Export failed. Please try again. – The export didn't finish. Check your internet connection and retry.

• State events export failed. – The user data export succeeded, but the state events file failed. Check your Downloads folder for the user data CSV.