Uploaded image for project: 'Admin Experience'
  1. Admin Experience
  2. AX-273

REST API endpoint to export all users to CSV

XMLWordPrintable

    • 148
    • 42

    • 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

       

            [AX-273] REST API endpoint to export all users to CSV

            SET Analytics Bot made changes -
            Support reference count Original: 40 New: 42
            SET Analytics Bot made changes -
            Support reference count Original: 39 New: 40
            Emma Yee made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 1046246 ]
            SET Analytics Bot made changes -
            Support reference count New: 39

            Adnane BENSAID added a comment -

            Hi, 

            Is there any updates for this feature ?

            Best regards,

            Adnane BENSAID added a comment - Hi,  Is there any updates for this feature ? Best regards,
            Stefan Scorse made changes -
            Remote Link New: This issue links to "Page (Confluence)" [ 1041196 ]
            Rodrigo B. made changes -
            Component/s Original: User Management Public APIs [ 56701 ]
            Component/s New: Directory - User Management REST API [ 80166 ]
            Key Original: ID-8451 New: AX-273
            Support reference count Original: 62
            Project Original: Identity [ 16810 ] New: Admin Experience [ 24210 ]
            SET Analytics Bot made changes -
            Support reference count Original: 61 New: 62
            SET Analytics Bot made changes -
            Support reference count Original: 60 New: 61
            SET Analytics Bot made changes -
            Support reference count Original: 59 New: 60

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

                Created:
                Updated: