get_info_on_all_users

Get Info On All Users

The scripts in this folder provide a variety of methods to pull information on all users in a PagerDuty account.

Get All Users' Contact Methods - contact_methods.py

This script retrieves contact info for all users in a PagerDuty account and outputs it in the console in an easy to read format.

Input Format

Running the script requires the provision of only one argument: a global REST API key

To execute the script, run this with your key:

./contact_methods.py -k API_KEY_HERE

Options

• -k/--api-key: (required) REST API key (should be a global key)

Get All Users With Certain Roles - get_users_by_role.py

This script will take a comma separated list of roles as a command line argument and fetches all the users in an account that match one of roles provided in the list. Roles will be fetched in the order that they are provided in the command line argument. Running with -v flag will show which role is being retrieved and then list the members who match it. After retrieving all the members for a given role, a tally will be shown for how many users have that role.

The script also creates a csv with names in the first column and users in the second. At the bottom of the CSV the totals for each role type are listed.

Input Format

Running the script requires the provision of three arguments: a global REST API key, a list of roles, and a filename for the csv output. See the "Options" section below for details.

To execute the script, run this with your key:

./get_users_by_role.py -k API-KEY-HERE -r COMMA-SEPARATED-ROLES-LIST -f FILENAME-FOR-CSV

You can also optionally turn on verbose logging in the console with the -v option.

Options

• -k/--api-key: (required) REST API key (should be a global key)
• -r/--roles: (required) A comma-separated list of roles to be fetched
  • Acceptable values for roles: admin,read_only_user,read_only_limited_user,user,limited_user,observer,restricted_access,owner,team_managers
• -f/--filename: (required) The filename to use for the output csv. If the argument entered doesn't end in .csv, then .csv will be appended.
• -v/--logging: (optional) Turn on verbose logging in the console

Get Team Roles of All Users - team_roles.py

This script will retrieves team roles for all users in a PagerDuty account that are members of any team. The default output is by user in the console, however you can optionally have the console output in comma-separated format for easier processing by using the -c option.

Input Format

Running the script requires the provision of just one argument: a global REST API key

To execute the script, run this with your key:

./team_roles.py -k API-KEY-HERE 

You can also optionally turn on comma-separated formatting in the console with the -c option.

Options

• -k/--api-key: (required) REST API key (should be a global key)
• -c/--comma-separated: (optional) Format console output separated by commas