Uploaded image for project: 'Identity'
  1. Identity
  2. ID-8451

REST API endpoint to export all users to CSV

XMLWordPrintable

    • 148
    • 22
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Summary

      As an administrator I would like to have a REST API endpoint that I can call in order to export users to CSV. The same CSV export you can get from the instance user management when you click on 'export all users' documented in the below page:

      Workaround

      It is possible to grab the cookie from an active site-admin session from the browser and then use it to authenticate a REST API POST request sent to the below internal endpoint (replace <CLOUD-ID> with your real cloud instance id):

      https://admin.atlassian.com/gateway/api/adminhub/um/site/<CLOUD-ID>/users/export
      

      As the body you can send something like:

      {
      includeApplicationAccess: true
      includeGroups: false
      includeInactiveUsers: true
      selectedGroupIds: []
      }
      

      Please notice this is just a workaround, the endpoint is not official, not documented and may change over time. You may find a sample Python script in this link.

      There is an updated Python script provided by the DEV team as the endpoint API is no longer valid link here

       

              2015ae912494 Stefan Scorse
              dbonotto Dario B
              Votes:
              186 Vote for this issue
              Watchers:
              112 Start watching this issue

                Created:
                Updated: