Bitbucket: add user usage report example and related method

Author: Gonchik Tsymzhitov

atlassian/bitbucket.py

@@ -1736,6 +1736,26 @@ def fork_repository(self, project, repository, new_repository):
             body['project'] = {'key': project}
         return self.post(url, data=body)
 
+    def get_users_info(self, user_filter=None, start=0, limit=25):
+        """
+        The authenticated user must have the LICENSED_USER permission to call this resource.
+        :param user_filter: if specified only users with usernames, display name or email addresses
+            containing the supplied string will be returned
+        :param limit:
+        :param start:
+        :return:
+        """
+        params = {}
+        if limit:
+            params['limit'] = limit
+        if start:
+            params['start'] = start
+        if user_filter:
+            params['filter'] = user_filter
+
+        url = "rest/api/1.0/admin/users"
+        return self.get(url, params=params)
+
     def get_current_license(self):
         """
         Retrieves details about the current license, as well as the current status of the system with

examples/bitbucket/bitbucket-check-last-auth-users.py

@@ -0,0 +1,65 @@
+from atlassian import Bitbucket
+from pprint import pprint
+from datetime import datetime
+import argparse
+import logging
+
+"""
+    That example shows how to make a report of bitbucket usage
+"""
+
+stash = Bitbucket(
+    url="https://stash.example.com",
+    username="admin",
+    password="*********",
+    timeout=60)
+
+
+def report(all=False, non_auth=False, limit=20):
+    response = stash.get_users_info(stash, limit=limit)
+    users = []
+    if response:
+        users = response.get("values") or []
+    for user in users:
+        print(user)
+        auth_date = user.get('lastAuthenticationTimestamp') or None
+        if auth_date:
+            auth_date = int(auth_date / 1000)
+            full_date = datetime.utcfromtimestamp(auth_date).strftime('%Y-%m-%d %H:%M:%S')
+        else:
+            full_date = None
+        if full_date:
+            output = f"{user.get('displayName')} ({user.get('emailAddress')}) authenticated on {full_date}"
+            if all:
+                print(output)
+        else:
+            output = f"{user.get('displayName')} ({user.get('emailAddress')}) not authenticated yet"
+            if non_auth or all:
+                print(output)
+
+
+if __name__ == '__main__':
+    """
+    This part of code only executes if we run this module directly.
+    You can still import the execute_build function and use it separately in the different module.
+    """
+    # Setting the logging level. INFO|ERROR|DEBUG are the most common.
+    logging.basicConfig(level=logging.ERROR)
+    # Initialize argparse module with some program name and additional information
+    parser = argparse.ArgumentParser(
+        prog="bitbucker_auth_reviewer",
+        usage="%(prog)s",
+        description="Simple script to make a report of authenticated or non authenticated users"
+    )
+    # Adding the build key as the first argument
+    parser.add_argument("--non-auth", help="Find non-auth users", dest='non_auth', action='store_true')
+    parser.add_argument("--all", help="Review all users", dest='all', action='store_true')
+    # Adding key=value parameters after the --arguments key
+    # Getting arguments
+    args = parser.parse_args()
+    if args.all:
+        report(all=True)
+    if args.non_auth:
+        report(non_auth=True)
+    else:
+        report(non_auth=False)

examples/bitbucket/stash-user-auth-report.py

@@ -0,0 +1,43 @@
+from atlassian import Bitbucket
+from pprint import pprint
+from datetime import datetime
+import argparse
+import logging
+
+"""
+    That example shows how to make a report of bitbucket usage
+"""
+
+stash = Bitbucket(
+    url="https://stash.example.com",
+    username="admin",
+    password="*************",
+    timeout=60)
+
+
+def report(limit=200, include_in_active=False):
+    response = stash.get_users_info(stash, limit=limit)
+    users = []
+    if response:
+        users = response.get("values") or []
+    print("|Status|Display name| Email |Last Auth DateTime|")
+    for user in users:
+        auth_date = user.get('lastAuthenticationTimestamp') or None
+        if auth_date:
+            auth_date = int(auth_date / 1000)
+            full_date = datetime.utcfromtimestamp(auth_date).strftime('%Y-%m-%d %H:%M:%S')
+        else:
+            full_date = None
+        if include_in_active or user.get('active'):
+            output = f"|{user.get('active')}|{user.get('displayName')}|{user.get('emailAddress')}|{full_date}|"
+            print(output)
+
+
+if __name__ == '__main__':
+    """
+    This part of code only executes if we run this module directly.
+    You can still import the execute_build function and use it separately in the different module.
+    """
+    # Setting the logging level. INFO|ERROR|DEBUG are the most common.
+    logging.basicConfig(level=logging.ERROR)
+    report(limit=1000)