Export a list of portal users to CSV using ArcGIS API for Python

Summary

In some instances, it is necessary to export a list of organization users from Portal for ArcGIS. This can be done using the ListUsers command line utility, or Admin Tools for ArcGIS Online.

This article provides a workaround using ArcGIS API for Python to populate an empty CSV file with a list of portal users and the required properties, such as the username, role, and email.

Update 8/22/2024:

• Please note that this functionality is incorporated into the software via Member Reports:
  • Work with usage reports—Portal for ArcGIS | Documentation for ArcGIS Enterprise

Procedure

1. Import the necessary modules.

import csv  
from arcgis.gis import GIS

2. Specify the user credentials, and connect to Portal for ArcGIS.

gis = GIS("https://<gisserver>.<domain>.com/arcgis", "username", "password", verify_cert=False)

3. Create a new CSV file, and specify the file path.

outputFile = r"<full file path>"

4. List all the users.

users = gis.users.search()

#For organization with more than 100 users,
users = gis.users.search('*',  max_users=<number_of_users>)

Note:
The default maximum number of the search() function is 100.

5. Specify the fields to be displayed, and populate the data to the output file.

with open(outputFile, 'w', newline='') as ResultFile:
    wr = csv.writer(ResultFile)
    header = 'Username', 'Role', 'Email'
    wr.writerow(header)
    for user in users:
        UserRow = user.username, user.role, user.email
        wr.writerow(UserRow)

The following shows a sample of the full script:

import csv 
from arcgis.gis import GIS

gis = GIS("https://test.esri.com:7443/arcgis", "username", "password", verify_cert=False)

outputFile = r"C:\Users\Desktop\test.csv"

users = gis.users.search('*',  max_users=1000)

with open(outputFile, 'w', newline='') as ResultFile:
    wr = csv.writer(ResultFile)
    header = 'Username', 'Role', 'Email'
    wr.writerow(header)
    for user in users:
        UserRow = user.username, user.role, user.email
        wr.writerow(UserRow)