Merge pull request #154 from britive/develop

v4.3.0

Author: theborch

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Change Log (v2.8.1+)
 
+## v4.3.0 [2025-07-08]
+
+__What's New:__
+
+* Added `security.active_sessions` functionality to allow administrative session management.
+
+__Enhancements:__
+
+* None
+
+__Bug Fixes:__
+
+* None
+
+__Dependencies:__
+
+* None
+
+__Other:__
+
+* None
+
 ## v4.2.0 [2025-05-30]
 
 __What's New:__

src/britive/__init__.py

@@ -1 +1 @@
-__version__ = '4.2.0'
+__version__ = '4.3.0'

src/britive/security/__init__.py

@@ -1,3 +1,4 @@
+from .active_sessions import ActiveSessions
 from .api_tokens import ApiTokens
 from .policies import SecurityPolicies
 from .saml import Saml
@@ -6,6 +7,7 @@
 
 class Security:
     def __init__(self, britive) -> None:
+        self.active_sessions = ActiveSessions(britive)
         self.api_tokens = ApiTokens(britive)
         self.saml = Saml(britive)
         self.security_policies = SecurityPolicies(britive)

src/britive/security/active_sessions.py

@@ -0,0 +1,61 @@
+class ActiveSessions:
+    def __init__(self, britive) -> None:
+        self.britive = britive
+        self.base_urls = {
+            'applications': f'{self.britive.base_url}/paps/sessions',
+            'resources': f'{self.britive.base_url}/resource-manager/sessions',
+        }
+
+    def list_users(self, search_text: str = None) -> list:
+        """
+        Retrieve a list of users with active session(s), i.e. checked out profiles.
+
+        :return: List of users with active session(s).
+        """
+
+        params = {}
+
+        if search_text:
+            params['searchText'] = search_text
+
+        return self.britive.get(self.base_urls['applications'], params=params)
+
+    def list_user_sessions(self, user_id: str) -> dict:
+        """
+        Retrieve the active sessions (checked out profiles) of a given user.
+
+        :param user_id: The target user's ID.
+        :return: Dict of the user's active Application and Resources sessions.
+        """
+
+        return {
+            'applications': self.britive.get(f'{self.base_urls["applications"]}/{user_id}'),
+            'resources': self.britive.get(f'{self.base_urls["resources"]}/{user_id}'),
+        }
+
+    def checkin(self, user_id: str, profile_ids: list) -> None:
+        """
+        Checkin one or more active profile sessions for a given user.
+
+        :param user_id: The target user's ID.
+        :param profile_ids: List of target profile ID(s) to checkin.
+        :return: None
+        """
+        for transaction_id, profile_type in {
+            session['transactionId']: profile_type
+            for profile_type, sessions in self.list_user_sessions(user_id).items()
+            for session in sessions
+            if session.get('papId', session.get('profileId')) in profile_ids
+        }.items():
+            self.britive.delete(f'{self.base_urls[profile_type]}/{transaction_id}')
+
+    def checkin_all(self, user_id: str) -> None:
+        """
+        Checkin all active profiles sessions for a given user.
+
+        :param user_id: The target user's ID
+        :return: None
+        """
+
+        self.britive.delete(f'{self.base_urls["applications"]}/user/{user_id}')
+        self.britive.delete(f'{self.base_urls["resources"]}/checkin-all/{user_id}')