Listing members

Note:

This topic only applies to 10.2.1 and later versions.

Administrators can use a command line utility, called ListUsers, to generate a list of all the members in the portal. You can use this utility to periodically assess which users in your organization are members in the portal.

If you have recently upgraded your portal and must reduce the number of named users to the maximum allowed by your authorization file, you can use this utility to obtain the full list of members, and assess who can be removed. In this scenario, you'll edit the output file from the ListUsers utility to list only the user names of members that you want to delete from the portal. This edited list will serve as the input to the DeleteUsers utility. This process is described below.

Generating a list of members

Use the ListUsers command line utility that was installed with the software to list all of the members in the portal. The tool is located in the <Portal for ArcGIS installation location>/tools/accountmanagement directory. You'll designate input parameters to execute the utility. The utility must be run on the machine where Portal for ArcGIS is installed.

Note:

The utility can only be executed by a built-in administrator account; you cannot use an enterprise administrator account. The built-in account you use can be the initial administrator account you set up when you configured the portal or another built-in account that has been granted administrator privileges. If you have deleted the initial administrator account and do not have any other built-in administrator accounts available, you will need to create one to execute the utility. For instructions, see the Built-in portal accounts section of Adding 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) that will be created by the utility, for example, members.txt. No other file types are supported. If specifying only the name of a file, the file will be 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.
• <simple | detailed>—The mode in which the utility will be executed. By default, this parameter is set to simple, meaning that only the user names of members will be listed in the output text file. Each user name in the output text file is listed 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, and description—specify this parameter as detailed. All of the detailed information for the member in the output text file is separated by the pipe (|) character.

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

When you execute the command, the output text file is created in the directory you specified. You can use the information in this file to determine what users in your organization are members of the portal.

You can also edit the information in this file to list only the user names of members that you want to delete from the portal. This edited list will serve as the input to the DeleteUsers utility, which will remove the members from your portal in bulk. You'll need to 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 portal using this file, see Removing members.