Skip to main content

List members

Administrators can use a command-line utility, called ListUsers, to generate a list of all members in an ArcGIS Enterprise organization. Use this utility to periodically assess which users are members of your organization.

If you have recently upgraded ArcGIS Enterprise and must reduce the number of named users to the maximum allowed by your authorization file, use this utility to obtain the full list of members and assess who can be removed. In this scenario, edit the output file from the ListUsers utility to list only the user names of members that you want to delete from your organization. This edited list serves as the input to the DeleteUsers utility. The following section describes this process.

Generate a list of members

Use the ListUsers command-line utility installed with the software to list all members in your organization. The tool is located in the <Portal for ArcGIS installation location>/tools/accountmanagement directory. Designate input parameters to execute the utility. Run the utility on the machine where Portal for ArcGIS is installed.

Use the ListUsers command-line utility installed with the software to list all members in your organization. The tool is located in the <Portal for ArcGIS installation location>\tools\accountmanagement directory. Designate input parameters to execute the utility. Run the utility on the machine where Portal for ArcGIS is installed.

Note:

Only a built-in administrator account, such as the initial administrator account, can run the utility. You cannot use an organization-specific administrator account. If you do not have any built-in administrator accounts available, you must create one to run the utility. For instructions, see the Built-in portal accounts section of Add members to your portal.

The available parameters are as follows:

ListUsers --output <file name> --format <simple | detailed>

  • <file name>—The name of a text file (.txt) created by the utility, for example, members.txt. No other file types are supported. If specifying only the name of a file, the file is created in the same directory where the tool resides. If you want the file to be created in another directory, specify the full path of the directory and the file name, for example, /data/organization/members.txt.

  • <file name>—The name of a text file (.txt) created by the utility, for example, members.txt. No other file types are supported. If specifying only the name of a file, the file is created in the same directory where the tool resides. If you want the file to be created in another directory, specify the full path of the directory and the file name, for example, C:\organization\members.txt.

  • <simple | detailed>—The mode in which the utility is executed. By default, this parameter is set to simple. This means that the output text file lists only member user names, with each user name on a separate line. If you want more information about the member in addition to the user name—for example, email address, full name, role, description, first name, and last name—specify this parameter as detailed. All detailed member information in the output text file is separated by the pipe (|) character.

Example: ./ListUsers.sh --output /data/organization/members.txt --format detailed

Example: ListUsers --output C:\organization\members.txt --format detailed

When you execute the command, the output text file is created in the directory you specified. Use the information in this file to determine which users in your organization are members.

You can also edit the information in this file to list only the user names of members that you want to remove from your organization. This edited list serves as the input to the DeleteUsers utility, which removes members in bulk. Edit the text file to remove all information except the user name. Each user name must be listed on a separate line, for example:

sarah
robert
james
qing

To learn how to remove members from your organization using this file, see Manage members.