|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
| 3 | +# this script retrieves all user role audit records for a given date range |
| 4 | +# the endpoint for audit records is https://api.pagerduty.com/audit/records |
| 5 | + |
| 6 | +import argparse |
| 7 | +import csv |
| 8 | +import json |
| 9 | +import pdpyras |
| 10 | +from datetime import datetime, timezone |
| 11 | +from dateutil import parser, relativedelta |
| 12 | +from tabulate import tabulate |
| 13 | + |
| 14 | +user_roles = { |
| 15 | + 'owner': 'Owner', |
| 16 | + 'admin': 'Global Admin', |
| 17 | + 'user': 'Manager', |
| 18 | + 'limited_user': 'Responder', |
| 19 | + 'observer': 'Observer', |
| 20 | + 'restricted_access': 'Restricted Access', |
| 21 | + 'read_only_limited_user': 'Limited Stakeholder', |
| 22 | + 'read_only_user': 'Stakeholder', |
| 23 | + 'none': 'None' |
| 24 | +} |
| 25 | + |
| 26 | +user_role_to_tier = { |
| 27 | + user_roles['owner']: 'Full User', |
| 28 | + user_roles['admin']: 'Full User', |
| 29 | + user_roles['user']: 'Full User', |
| 30 | + user_roles['limited_user']: 'Full User', |
| 31 | + user_roles['observer']: 'Full User', |
| 32 | + user_roles['restricted_access']: 'Full User', |
| 33 | + user_roles['read_only_limited_user']: 'Stakeholder', |
| 34 | + user_roles['read_only_user']: 'Stakeholder', |
| 35 | + user_roles['none']: 'None' |
| 36 | +} |
| 37 | + |
| 38 | +actor_types = { |
| 39 | + 'user_reference': 'User', |
| 40 | + 'app_reference': 'App', |
| 41 | + 'api_key_reference': 'API Key', |
| 42 | +} |
| 43 | + |
| 44 | +def get_api_path(user_id): |
| 45 | + return f'users/{user_id}/audit/records' if user_id else 'audit/records' |
| 46 | + |
| 47 | +def get_api_params(since, until, user_id): |
| 48 | + params={'since': since, 'until': until} |
| 49 | + if not user_id: |
| 50 | + params['root_resource_types[]'] = 'users' |
| 51 | + return params |
| 52 | + |
| 53 | +def print_changes(changes, tier_changes): |
| 54 | + header = header_row(tier_changes) |
| 55 | + print(tabulate(header + changes, tablefmt='grid')) |
| 56 | + |
| 57 | +def write_changes_to_csv(changes, tier_changes, filename): |
| 58 | + header = header_row(tier_changes) |
| 59 | + with open(filename, 'w') as csvfile: |
| 60 | + writer = csv.DictWriter(csvfile, fieldnames=header[0].keys()) |
| 61 | + writer.writerows(header + changes) |
| 62 | + |
| 63 | +def header_row(tier_changes): |
| 64 | + header = { |
| 65 | + 'date': 'Date', |
| 66 | + 'id': 'User ID', |
| 67 | + 'summary': 'User Name', |
| 68 | + 'before_value': 'Role Before', |
| 69 | + 'value': 'Role After', |
| 70 | + 'actor_id': 'Actor ID', |
| 71 | + 'actor_type': 'Actor Type', |
| 72 | + 'actor_summary': 'Actor Summary' |
| 73 | + } |
| 74 | + |
| 75 | + if tier_changes: |
| 76 | + header.update({'before_value': 'Role Tier Before', 'value': 'Role Tier After'}) |
| 77 | + |
| 78 | + return [header] |
| 79 | + |
| 80 | +def get_record_actor(record): |
| 81 | + actors = record.get('actors', []) |
| 82 | + if not len(actors): |
| 83 | + return { |
| 84 | + 'actor_type': '', |
| 85 | + 'actor_id': '', |
| 86 | + 'actor_summary': '' |
| 87 | + } |
| 88 | + |
| 89 | + actor = actors[0] |
| 90 | + return { |
| 91 | + 'actor_type': actor_types[actor['type']], |
| 92 | + 'actor_id': actor['id'], |
| 93 | + 'actor_summary': actor.get('summary', '') |
| 94 | + } |
| 95 | + |
| 96 | +def get_role_changes(record, only_updates): |
| 97 | + if only_updates and record['action'] != 'update': |
| 98 | + return [] |
| 99 | + |
| 100 | + # `details` and `fields` can both be null according to the API docs. |
| 101 | + field_changes = record.get('details', {}).get('fields', []) |
| 102 | + role_changes = filter(lambda fc: fc['name'] == 'role', field_changes) |
| 103 | + |
| 104 | + def format_role_change(role_change): |
| 105 | + role_change = { |
| 106 | + 'id': record['root_resource']['id'], |
| 107 | + 'summary': record['root_resource'].get('summary', ''), |
| 108 | + 'value': user_roles[role_change.get('value', 'none')], |
| 109 | + 'before_value': user_roles[role_change.get('before_value', 'none')], |
| 110 | + 'date': record['execution_time'] |
| 111 | + } |
| 112 | + role_change.update(get_record_actor(record)) |
| 113 | + return role_change |
| 114 | + |
| 115 | + return list(map(format_role_change, role_changes)) |
| 116 | + |
| 117 | +def get_role_tier_changes(role_changes): |
| 118 | + tier_changes = [] |
| 119 | + for role_change in role_changes: |
| 120 | + role_change['value'] = user_role_to_tier[role_change['value']] |
| 121 | + role_change['before_value'] = user_role_to_tier[role_change['before_value']] |
| 122 | + if role_change['value'] != role_change['before_value']: |
| 123 | + tier_changes.append(role_change) |
| 124 | + |
| 125 | + return tier_changes |
| 126 | + |
| 127 | +def chunk_date_range(args): |
| 128 | + # Mirror the default of the audit APIs, get records for the last 24 hours |
| 129 | + since, until = args.since, args.until |
| 130 | + if not since or not until: |
| 131 | + now = datetime.now(timezone.utc) |
| 132 | + yesterday = now - relativedelta.relativedelta(hours=+24) |
| 133 | + yield (datetime.isoformat(yesterday), datetime.isoformat(now)) |
| 134 | + return |
| 135 | + |
| 136 | + since = parser.isoparse(since) |
| 137 | + until = parser.isoparse(until) |
| 138 | + |
| 139 | + if since > until: |
| 140 | + raise 'Invalid date range' |
| 141 | + |
| 142 | + # Audit API requests have a date range limit of 31 days, so we |
| 143 | + # split the requested date range into 30 day chunks |
| 144 | + while True: |
| 145 | + next_since = since + relativedelta.relativedelta(days=+30) |
| 146 | + if next_since < until: |
| 147 | + yield (datetime.isoformat(since), datetime.isoformat(next_since)) |
| 148 | + since = next_since |
| 149 | + else: |
| 150 | + yield (datetime.isoformat(since), datetime.isoformat(until)) |
| 151 | + return |
| 152 | + |
| 153 | +def main(args, session): |
| 154 | + user_id, tier_changes = args.user_id, args.tier_changes |
| 155 | + try: |
| 156 | + role_changes = [] |
| 157 | + chunked_date_range = chunk_date_range(args) |
| 158 | + for since, until in chunked_date_range: |
| 159 | + for record in session.iter_cursor(get_api_path(user_id), params=get_api_params(since, until, user_id)): |
| 160 | + if args.show_all: |
| 161 | + print(json.dumps(record)) |
| 162 | + record_role_changes = get_role_changes(record, args.only_updates) |
| 163 | + role_changes += record_role_changes |
| 164 | + |
| 165 | + changes = get_role_tier_changes(role_changes) if tier_changes else role_changes |
| 166 | + if len(changes): |
| 167 | + changes = sorted(changes, key=lambda rc: rc['date']) |
| 168 | + print_changes(changes, tier_changes) |
| 169 | + if args.filename: |
| 170 | + write_changes_to_csv(changes, tier_changes, args.filename) |
| 171 | + else: |
| 172 | + print(f'No {"tier" if tier_changes else "role"} changes found.') |
| 173 | + |
| 174 | + except pdpyras.PDClientError as e: |
| 175 | + print('Could not get user role change audit records') |
| 176 | + raise e |
| 177 | + |
| 178 | +if __name__ == '__main__': |
| 179 | + ap = argparse.ArgumentParser(description='Prints all user role or tier changes between the given dates') |
| 180 | + ap.add_argument('-k', '--api-key', required=True, help='REST API key') |
| 181 | + ap.add_argument('-s', '--since', required=False, help='Start of date range to search') |
| 182 | + ap.add_argument('-u', '--until', required=False, help='End of date range to search') |
| 183 | + ap.add_argument('-i', '--user-id', required=False, help='Filter results to a single user ID') |
| 184 | + ap.add_argument('-o', '--only-updates', action='store_true', help='Exclude user creates and deletes from role change results') |
| 185 | + ap.add_argument('-t', '--tier-changes', action='store_true', help='Get user role tier changes') |
| 186 | + ap.add_argument('-a', '--show-all', action='store_true', help='Prints all fetched user records in JSON format') |
| 187 | + ap.add_argument('-f', '--filename', required=False, help='Write results to a CSV file') |
| 188 | + args = ap.parse_args() |
| 189 | + session = pdpyras.APISession(args.api_key) |
| 190 | + |
| 191 | + main(args, session) |
0 commit comments