Merge pull request #138 from britive/v4.0.0

v4.0.0

Author: theborch

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log (v2.8.1+)
 
-## v3.2.0-beta.1 [2025-01-15]
+## v4.0.0 [2025-01-17]
 
 __What's New:__
 
@@ -25,17 +25,50 @@ __Enhancements:__
 __Bug Fixes:__
 
 * Fixed missing `param_values` option for resource creation.
-* `my_requests.list_approvals` now includes `my_resources` requests.
+* `my_approvals.list` now includes `my_resources` requests.
 * Make `get` call in helper method instead `list_approvals`.
-* Catch `requests.exceptions.JSONDecodeError` in `_handle_response`.
+* Catch `requests.exceptions.JSONDecodeError` in `handle_response`.
 
 __Dependencies:__
 
 * `requests >= 2.32.0`
 
 __Other:__
 
-* None
+* Python 3.8 is EOL, so support is dropped.
+* Method assignments dropped:
+
+| Dropped                                | New location                                  |
+| -------------------------------------- | --------------------------------------------- |
+| `access_builder`                       | `application_management.access_builder`       |
+| `accounts`                             | `application_management.accounts`             |
+| `applications`                         | `application_management.applications`         |
+| `audit_logs`                           | `audit_logs.logs`                             |
+| `environment_groups`                   | `application_management.environment_groups`   |
+| `environments`                         | `application_management.environments`         |
+| `groups`                               | `application_management.groups`               |
+| `identity_attributes`                  | `identity_management.identity_attributes`     |
+| `identity_providers`                   | `identity_management.identity_providers`      |
+| `notification_mediums`                 | `global_settings.notification_mediums`        |
+| `notifications`                        | `workflows.notifications`                     |
+| `permissions`                          | `application_management.permissions`          |
+| `profiles`                             | `application_management.profiles`             |
+| `saml`                                 | `security.saml`                               |
+| `scans`                                | `application_management.scans`                |
+| `security_policies`                    | `security.security_policies`                  |
+| `service_identities`                   | `identity_management.service_identities`      |
+| `service_identity_tokens`              | `identity_management.service_identity_tokens` |
+| `settings`                             | `global_settings`                             |
+| `step_up`                              | `security.step_up_auth`                       |
+| `tags`                                 | `identity_management.tags`                    |
+| `task_services`                        | `workflows.task_services`                     |
+| `tasks`                                | `workflows.tasks`                             |
+| `users`                                | `identity_management.users`                   |
+| `workload`                             | `identity_management.workload`                |
+| `my_access.approval_request_status`    | `my_requests.approval_request_status`         |
+| `my_access.approve_request`            | `my_approvals.approve_request`                |
+| `my_access.list_approvals`             | `my_approvals.list`                           |
+| `my_access.reject_request`             | `my_approvals.reject_request`                 |
 
 ## v3.1.0 [2024-10-07]
 

CONTRIBUTING.md

@@ -7,7 +7,7 @@ can consume a native Python library.
 
 ## Python Version Support
 
-_CURRENT SUPPORTED VERSION(S):_ `>= 3.8`
+_CURRENT SUPPORTED VERSION(S):_ `>= 3.9`
 
 We use [typing](https://docs.python.org/3/library/typing.html) and dictionary unpacking, e.g. `{**dict1, **dict2}`,
 which requires Python 3.5 or greater.

DEPRECATION.md

@@ -1,6 +1,48 @@
 # Deprecation Notices
 
-This document holds the items which are deprecated and will be retired in the next major release.
+This document holds the items which are deprecated and/or warrant specific call out with each major release.
+
+
+## Moved methods in `v4.0.0`
+
+### `my_access` methods have moved:
+
+| Old location                           | New location                                  |
+| -------------------------------------- | --------------------------------------------- |
+| `my_access.approval_request_status`    | `my_requests.approval_request_status`         |
+| `my_access.approve_request`            | `my_approvals.approve_request`                |
+| `my_access.list_approvals`             | `my_approvals.list`                           |
+| `my_access.reject_request`             | `my_approvals.reject_request`                 |
+
+### `britive` methods have moved:
+
+| Old location                           | New location                                  |
+| -------------------------------------- | --------------------------------------------- |
+| `access_builder`                       | `application_management.access_builder`       |
+| `accounts`                             | `application_management.accounts`             |
+| `applications`                         | `application_management.applications`         |
+| `audit_logs`                           | `audit_logs.logs`                             |
+| `environment_groups`                   | `application_management.environment_groups`   |
+| `environments`                         | `application_management.environments`         |
+| `groups`                               | `application_management.groups`               |
+| `identity_attributes`                  | `identity_management.identity_attributes`     |
+| `identity_providers`                   | `identity_management.identity_providers`      |
+| `notification_mediums`                 | `global_settings.notification_mediums`        |
+| `notifications`                        | `workflows.notifications`                     |
+| `permissions`                          | `application_management.permissions`          |
+| `profiles`                             | `application_management.profiles`             |
+| `saml`                                 | `security.saml`                               |
+| `scans`                                | `application_management.scans`                |
+| `security_policies`                    | `security.security_policies`                  |
+| `service_identities`                   | `identity_management.service_identities`      |
+| `service_identity_tokens`              | `identity_management.service_identity_tokens` |
+| `settings`                             | `global_settings`                             |
+| `step_up`                              | `security.step_up_auth`                       |
+| `tags`                                 | `identity_management.tags`                    |
+| `task_services`                        | `workflows.task_services`                     |
+| `tasks`                                | `workflows.tasks`                             |
+| `users`                                | `identity_management.users`                   |
+| `workload`                             | `identity_management.workload`                |
 
 ## Removed in Major Release 3.0.0
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Britive, Inc
+Copyright (c) 2025 Britive, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -7,7 +7,7 @@ This package aims to wrap the Britive API for usage in Python development. For t
 the developer/end user experience. Some APIs may also be combined into one Python method with a parameter if and where
 it makes more sense to present the API that way.
 
-This package supports Python versions `>= 3.8`.
+This package supports Python versions `>= 3.9`.
 
 ## Installation
 

pyproject.toml

@@ -14,7 +14,6 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
@@ -24,7 +23,7 @@ classifiers = [
     "Topic :: Security",
 ]
 license = {file = "LICENSE"}
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = [
     "requests>=2.32.0"
 ]

src/britive/__init__.py

@@ -1 +1 @@
-__version__ = '3.2.0-beta.1'
+__version__ = '4.0.0'

src/britive/access_broker/response_templates.py

@@ -9,6 +9,7 @@ def create(
         name: str,
         description: str = '',
         is_console_enabled: bool = False,
+        show_on_ui: bool = False,
     ) -> dict:
         """
         Create a new response template.
@@ -17,14 +18,16 @@ def create(
         :param description: Description of the response template.
         :param template_data: Template data.
         :param is_console_enabled: Is console enabled.
+        :param show_on_ui: Show on UI.
         :return: Created response template.
         """
 
         params = {
             'name': name,
             'description': description,
             'template_data': template_data,
-            'is_console_enabled': is_console_enabled,
+            'isConsoleAccessEnabled': is_console_enabled,
+            'show_on_ui': show_on_ui,
         }
 
         return self.britive.post(self.base_url, json=params)

src/britive/application_management/applications.py

@@ -137,7 +137,7 @@ def scan(self, application_id: str) -> dict:
         the accounts in the org and their place in the OU structure.
 
         Scans are asynchronous operations. The response will include a `taskId` which can be used to make calls
-        to `britive.scans.status()` to obtain the current status of the scan.
+        to `britive.application_management.scans.status()` to obtain the current status of the scan.
 
         Note that scans can also be initiated from the Scans class. The same type of scan will be performed no matter
         where it is initiated.
@@ -146,7 +146,7 @@ def scan(self, application_id: str) -> dict:
         :return: Details of the scan that was initiated.
         """
 
-        return self.britive.scans.scan(application_id=application_id)
+        return self.britive.application_management.scans.scan(application_id=application_id)
 
     def delete(self, application_id: str) -> None:
         """

src/britive/application_management/environments.py

@@ -22,7 +22,7 @@ def create(self, application_id: str, name: str, description: str = '', parent_g
             'type': 'environment',
             'description': description,
             'parentGroupId': parent_group_id
-            or self.britive.environment_groups.get_or_create_root(application_id=application_id),
+            or self.britive.application_management.environment_groups.get_or_create_root(application_id=application_id),
         }
 
         return self.britive.post(f'{self.base_url}/{application_id}/root-environment-group/environments', json=data)
@@ -91,7 +91,7 @@ def scan(self, application_id: str, environment_id: str) -> dict:
         For all other application types the application will be scanned and not the underlying environment(s).
 
         Scans are asynchronous operations. The response will include a `taskId` which can be used to make calls
-        to `britive.scans.status()` to obtain the current status of the scan.
+        to `britive.application_management.scans.status()` to obtain the current status of the scan.
 
         Note that scans can also be initiated from the Scans class. The same type of scan will be performed no matter
         where it is initiated.
@@ -101,7 +101,9 @@ def scan(self, application_id: str, environment_id: str) -> dict:
         :return: Details of the scan that was initiated.
         """
 
-        return self.britive.scans.scan(application_id=application_id, environment_id=environment_id)
+        return self.britive.application_management.scans.scan(
+            application_id=application_id, environment_id=environment_id
+        )
 
     def delete(self, application_id: str, environment_id: str) -> None:
         """