zscaler-sdk-python 0.3.1__tar.gz → 0.5.0__tar.gz

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.3.1
+Version: 0.5.0
 Summary: Official Python SDK for the Zscaler Products (Beta)
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -24,21 +24,21 @@ Provides-Extra: dev
 Requires-Dist: aenum ; extra == "dev"
 Requires-Dist: arrow
 Requires-Dist: black (>=24.3.0) ; extra == "dev"
-Requires-Dist: certifi
+Requires-Dist: certifi (>=2024.2.2)
 Requires-Dist: charset-normalizer
-Requires-Dist: cryptography (>=3.4,<43.0)
+Requires-Dist: cryptography (>=42.0.7)
 Requires-Dist: flake8
 Requires-Dist: flatdict
 Requires-Dist: idna
 Requires-Dist: okta (>=2.9.7)
 Requires-Dist: pycryptodomex
 Requires-Dist: pydash ; extra == "dev"
-Requires-Dist: python-box (>=7.1.1,<8.0.0)
+Requires-Dist: python-box (>=7.2.0,<8.0.0)
 Requires-Dist: python-dateutil
 Requires-Dist: pytz
 Requires-Dist: pyyaml
 Requires-Dist: requests (>=2.32.0)
-Requires-Dist: responses
+Requires-Dist: responses (>=0.25.3)
 Requires-Dist: restfly
 Requires-Dist: six
 Requires-Dist: xmltodict

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "0.3.1"
+version = "0.5.0"
 description = "Official Python SDK for the Zscaler Products (Beta)"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -30,13 +30,13 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.8,<4.0"
 arrow = "*"
-certifi = "*"
+certifi = ">=2024.2.2"
 charset-normalizer = "*"
 idna = "*"
-python-box = "^7.1.1"
+python-box = "^7.2.0"
 python-dateutil = "*"
 requests = ">=2.32.0"
-responses = "*"
+responses = ">=0.25.3"
 restfly = "*"
 six = "*"
 flatdict = "*"
@@ -49,12 +49,13 @@ pydash = "*"
 flake8 = "*"
 pytz = "*"
 black = ">=24.3.0"
-cryptography = ">=3.4,<43.0"
+# cryptography = ">=3.4,<43.0"
+cryptography = ">=42.0.7"
 okta = ">=2.9.7"
 
 [tool.poetry.dev-dependencies]
 black = ">=24.3.0"
-pytest = "^8.2.1"
+pytest = ">=8.2.1"
 pytest-asyncio = ">=0.23.7"
 pytest-mock = "*"
 pytest-recording = "*"

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "0.3.1"
+__version__ = "0.5.0"
 
 from zscaler.zia import ZIAClientHelper  # noqa
 from zscaler.zpa import ZPAClientHelper  # noqa

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/zscaler/constants.py

@@ -14,7 +14,7 @@ ZPA_BASE_URLS = {
 
 DEV_AUTH_URL = "https://authn1.dev.zpath.net/authn/v1/oauth/token"
 
-RETRYABLE_STATUS_CODES = {429, 500, 502, 503, 504}
+RETRYABLE_STATUS_CODES = {409, 429, 500, 502, 503, 504}
 MAX_RETRIES = 5
 BACKOFF_FACTOR = 1
 BACKOFF_BASE_DURATION = 2

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/zscaler/utils.py

@@ -147,11 +147,42 @@ def add_id_groups(id_groups: list, kwargs: dict, payload: dict):
     return
 
 
+# def transform_common_id_fields(id_groups: list, kwargs: dict, payload: dict):
+#     for entry in id_groups:
+#         if kwargs.get(entry[0]):
+#             # Ensure each ID is treated as an integer before adding it to the payload
+#             payload[entry[1]] = [{"id": int(param_id)} for param_id in kwargs.pop(entry[0])]
+#     return
+
+# ####### Function used in the ZIA Forwarding Control Rule #######
+# def transform_fwd_id_fields(id_groups: list, kwargs: dict, payload: dict):
+#     for entry in id_groups:
+#         key, payload_key = entry
+#         if key in kwargs:
+#             value = kwargs.pop(key)
+#             if isinstance(value, dict):
+#                 payload[payload_key] = {k: v for k, v in value.items() if k in ['id', 'name']}
+#             elif isinstance(value, list):
+#                 payload[payload_key] = [{"id": int(item)} if isinstance(item, str) and item.isdigit() else item for item in value]
+#     return
+
 def transform_common_id_fields(id_groups: list, kwargs: dict, payload: dict):
     for entry in id_groups:
-        if kwargs.get(entry[0]):
-            # Ensure each ID is treated as an integer before adding it to the payload
-            payload[entry[1]] = [{"id": int(param_id)} for param_id in kwargs.pop(entry[0])]
+        key, payload_key = entry
+        if key in kwargs:
+            value = kwargs.pop(key)
+            if key in ["zpa_gateway", "proxy_gateway", "zpa_server_group"]:
+                # Handle zpa_gateway, proxy_gateway, and zpa_server_group
+                if isinstance(value, dict):
+                    payload[payload_key] = {snake_to_camel(k): v for k, v in value.items() if k in ['id', 'name', 'external_id']}
+            elif key in ["zpa_app_segments", "zpa_application_segments", "zpa_application_segment_groups"]:
+                # Handle zpa_app_segments, zpa_application_segments, and zpa_application_segment_groups
+                if isinstance(value, list):
+                    payload[payload_key] = [{"externalId": item["external_id"], "name": item["name"]} for item in value]
+            else:
+                # General case for ID transformations
+                if isinstance(value, list):
+                    payload[payload_key] = [{"id": int(item)} if isinstance(item, (str, int)) else item for item in value]
     return
 
 
@@ -544,3 +575,4 @@ def dump_response(
         log_lines.append(f"\n{response_body}")
     log_lines.append("-" * 68)
     logger.info("\n".join(log_lines))
+

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/zscaler/zia/firewall.py

@@ -233,10 +233,7 @@ class FirewallPolicyAPI:
 
         response = self.rest.put(f"firewallFilteringRules/{rule_id}", json=payload)
         if isinstance(response, Response) and not response.ok:
-            # Handle error response
             raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
-
-        # Return the updated object
         return self.get_rule(rule_id)
 
     def delete_rule(self, rule_id: str) -> int:

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/zscaler/zia/forwarding_control.py

@@ -68,10 +68,7 @@ class ForwardingControlAPI:
             ...    pprint(rule)
 
         """
-        response = self.rest.get("/forwardingRules")
-        if isinstance(response, Response):
-            return None
-        return response
+        return self.rest.get("forwardingRules")
 
     def get_rule(self, rule_id: str) -> Box:
         """
@@ -158,18 +155,19 @@ class ForwardingControlAPI:
 
         # Transform ID fields in kwargs
         transform_common_id_fields(self.reformat_params, kwargs, payload)
+
         for key, value in kwargs.items():
             if value is not None:
-                payload[snake_to_camel(key)] = value
+                if key == "state" and isinstance(value, bool):
+                    payload[key] = "ENABLED" if value else "DISABLED"
+                else:
+                    payload[key] = value
 
         # Convert the entire payload's keys to camelCase before sending
         camel_payload = recursive_snake_to_camel(payload)
-        for key, value in kwargs.items():
-            if value is not None:
-                camel_payload[snake_to_camel(key)] = value
 
         # Send POST request to create the rule
-        response = self.rest.post("forwardingRules", json=payload)
+        response = self.rest.post("forwardingRules", json=camel_payload)
         if isinstance(response, Response):
             # Handle error response
             status_code = response.status_code
@@ -227,7 +225,6 @@ class ForwardingControlAPI:
             ...    description="TT#1965232866")
 
         """
-
         # Set payload to value of existing record and convert nested dict keys.
         payload = convert_keys(self.get_rule(rule_id))
 
@@ -240,14 +237,14 @@ class ForwardingControlAPI:
 
         # Add remaining optional parameters to payload
         for key, value in kwargs.items():
-            payload[snake_to_camel(key)] = value
+            if key == "state" and isinstance(value, bool):
+                payload[snake_to_camel(key)] = "ENABLED" if value else "DISABLED"
+            else:
+                payload[snake_to_camel(key)] = value
 
         response = self.rest.put(f"forwardingRules/{rule_id}", json=payload)
         if isinstance(response, Response) and not response.ok:
-            # Handle error response
             raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
-
-        # Return the updated object
         return self.get_rule(rule_id)
 
     def delete_rule(self, rule_id: str) -> int:

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/zscaler/zia/zpa_gateway.py

@@ -17,7 +17,7 @@
 from box import Box, BoxList
 from requests import Response
 
-from zscaler.utils import convert_keys, snake_to_camel
+from zscaler.utils import convert_keys, snake_to_camel, transform_common_id_fields
 from zscaler.zia import ZIAClient
 
 
@@ -68,7 +68,6 @@ class ZPAGatewayAPI:
         self,
         name: str,
         zpa_server_group: dict = None,
-        zpa_app_segments: list = None,
         **kwargs,
     ) -> Box:
         """
@@ -95,24 +94,21 @@ class ZPAGatewayAPI:
         """
         payload = {"name": name, "type": "ZPA"}
 
+        # Add zpa_server_group to kwargs
         if zpa_server_group:
-            payload["zpaServerGroup"] = {
-                "externalId": zpa_server_group.get("external_id"),
-                "name": zpa_server_group.get("name"),
-            }
+            kwargs["zpa_server_group"] = zpa_server_group
+            
+        # Define the id groups specific to this function
+        zpa_gateway_id_groups = [
+            ("zpa_server_group", "zpaServerGroup"),
+        ]
+        transform_common_id_fields(zpa_gateway_id_groups, kwargs, payload)
 
-        if zpa_app_segments:
-            payload["zpaAppSegments"] = [
-                {"externalId": segment.get("external_id"), "name": segment.get("name")} for segment in zpa_app_segments
-            ]
-
-        # Add other optional parameters to payload
         for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
         response = self.rest.post("zpaGateways", json=payload)
         if isinstance(response, Response):
-            # Handle error response
             status_code = response.status_code
             raise Exception(f"API call failed with status {status_code}: {response.json()}")
         return response
@@ -143,25 +139,24 @@ class ZPAGatewayAPI:
         """
         payload = convert_keys(self.get_gateway(gateway_id))
 
-        # Update payload with provided arguments
-        for key, value in kwargs.items():
-            if key == "zpa_server_group" and isinstance(value, dict):
-                # Convert nested keys in zpa_server_group to camelCase
-                value = {snake_to_camel(k): v for k, v in value.items()}
-            elif key == "zpa_app_segments" and isinstance(value, list):
-                # Convert nested keys in zpa_app_segments to camelCase
-                value = [{snake_to_camel(k): v for k, v in item.items()} for item in value]
+        if "zpa_server_group" in kwargs:
+            kwargs["zpa_server_group"] = kwargs["zpa_server_group"]
+
+        # Define the id groups specific to this function
+        zpa_gateway_id_groups = [
+            ("zpa_server_group", "zpaServerGroup"),
+        ]
 
+        transform_common_id_fields(zpa_gateway_id_groups, kwargs, payload)
+        
+        for key, value in kwargs.items():
             payload[snake_to_camel(key)] = value
 
         response = self.rest.put(f"zpaGateways/{gateway_id}", json=payload)
         if isinstance(response, Response) and not response.ok:
-            # Handle error response
-            raise Exception(f"API call failed with status {response.status_code}: " f"{response.json()}")
-
-        # Return the updated object
+            raise Exception(f"API call failed with status {response.status_code}: {response.json()}")
         return self.get_gateway(gateway_id)
-
+    
     def delete_gateway(self, gateway_id):
         """
         Deletes the specified ZPA Gateway.

{zscaler_sdk_python-0.3.1 → zscaler_sdk_python-0.5.0}/zscaler/zpa/__init__.py

@@ -26,6 +26,7 @@ from zscaler.utils import (
     retry_with_backoff,
     snake_to_camel,
 )
+from zscaler.zpa.authdomains import AuthDomainsAPI
 from zscaler.zpa.app_segments import ApplicationSegmentAPI
 from zscaler.zpa.app_segments_inspection import AppSegmentsInspectionAPI
 from zscaler.zpa.app_segments_pra import AppSegmentsPRAAPI
@@ -39,6 +40,7 @@ from zscaler.zpa.inspection import InspectionControllerAPI
 from zscaler.zpa.isolation import IsolationAPI
 from zscaler.zpa.lss import LSSConfigControllerAPI
 from zscaler.zpa.machine_groups import MachineGroupsAPI
+from zscaler.zpa.microtenants import MicrotenantsAPI
 from zscaler.zpa.policies import PolicySetsAPI
 from zscaler.zpa.posture_profiles import PostureProfilesAPI
 from zscaler.zpa.privileged_remote_access import PrivilegedRemoteAccessAPI
@@ -81,12 +83,12 @@ class ZPAClientHelper(ZPAClient):
         client_secret,
         customer_id,
         cloud,
+        microtenant_id=None,
         timeout=240,
         cache=None,
         fail_safe=False,
     ):
         # Initialize rate limiter
-        # You may want to adjust these parameters as per your rate limit configuration
         self.rate_limiter = RateLimiter(
             get_limit=20,  # Adjusted to allow 20 GET requests per 10 seconds
             post_put_delete_limit=10,  # Adjusted to allow 10 POST/PUT/DELETE requests per 10 seconds
@@ -94,7 +96,6 @@ class ZPAClientHelper(ZPAClient):
             post_put_delete_freq=10,  # Adjust frequency to 10 seconds
         )
 
-        # Validate cloud value
         if cloud not in ZPA_BASE_URLS:
             valid_clouds = ", ".join(ZPA_BASE_URLS.keys())
             raise ValueError(
@@ -102,15 +103,13 @@ class ZPAClientHelper(ZPAClient):
                 f"Please use one of the following supported values: {valid_clouds}"
             )
 
-        # Continue with existing initialization...
-        # Select the appropriate URL
         self.baseurl = ZPA_BASE_URLS.get(cloud, ZPA_BASE_URLS["PRODUCTION"])
-
         self.timeout = timeout
         self.client_id = client_id
         self.client_secret = client_secret
         self.customer_id = customer_id
         self.cloud = cloud
+        self.microtenant_id = microtenant_id or os.getenv("ZPA_MICROTENANT_ID")
         self.url = f"{self.baseurl}/mgmtconfig/v1/admin/customers/{customer_id}"
         self.user_config_url = f"{self.baseurl}/userconfig/v1/customers/{customer_id}"
         self.v2_url = f"{self.baseurl}/mgmtconfig/v2/admin/customers/{customer_id}"
@@ -118,7 +117,6 @@ class ZPAClientHelper(ZPAClient):
         self.cbi_url = f"{self.baseurl}/cbiconfig/cbi/api/customers/{customer_id}"
         self.fail_safe = fail_safe
 
-        # Cache setup
         cache_enabled = os.environ.get("ZSCALER_CLIENT_CACHE_ENABLED", "true").lower() == "true"
         if cache is None:
             if cache_enabled:
@@ -130,7 +128,6 @@ class ZPAClientHelper(ZPAClient):
         else:
             self.cache = cache
 
-        # Initialize user-agent
         ua = UserAgent()
         self.user_agent = ua.get_user_agent_string()
         self.access_token = None
@@ -184,20 +181,34 @@ class ZPAClientHelper(ZPAClient):
         elif api_version == "cbiconfig_v1":
             api = self.cbi_url
 
+        if params is None:
+            params = {}
+
+        if json and "microtenant_id" in json:
+            microtenant_id = json.pop("microtenant_id")
+        else:
+            microtenant_id = self.microtenant_id
+
+        if microtenant_id:
+            params["microtenantId"] = microtenant_id
+
         url = f"{api}/{path.lstrip('/')}"
+        if params:
+            url = f"{url}?{urllib.parse.urlencode(params)}"
+
         start_time = time.time()
         headers_with_user_agent = self.headers.copy()
         headers_with_user_agent["User-Agent"] = self.user_agent
         request_uuid = uuid.uuid4()
-        dump_request(logger, url, method, json, params, headers_with_user_agent, request_uuid)
-        cache_key = self.cache.create_key(url, params)
+        dump_request(logger, url, method, json, None, headers_with_user_agent, request_uuid)
+        cache_key = self.cache.create_key(url, None)
         if method == "GET" and self.cache.contains(cache_key):
             resp = self.cache.get(cache_key)
             dump_response(
                 logger=logger,
                 url=url,
                 method=method,
-                params=params,
+                params=None,
                 resp=resp,
                 request_uuid=request_uuid,
                 start_time=start_time,
@@ -217,13 +228,14 @@ class ZPAClientHelper(ZPAClient):
                     method,
                     url,
                     json=json,
+                    params=None,
                     headers=headers_with_user_agent,
                     timeout=self.timeout,
                 )
                 dump_response(
                     logger=logger,
                     url=url,
-                    params=params,
+                    params=None,
                     method=method,
                     resp=resp,
                     request_uuid=request_uuid,
@@ -366,6 +378,7 @@ class ZPAClientHelper(ZPAClient):
         search_field="name",
         max_pages=None,
         max_items=None,
+        all_entries=False,  # Return all SCIM groups including the deleted ones if set to true
         sort_order=None,
         sort_by=None,
         sort_dir=None,
@@ -373,8 +386,10 @@ class ZPAClientHelper(ZPAClient):
         end_time=None,
         idp_group_id=None,
         scim_user_id=None,
+        scim_username=None,
         page=None,
-        pagesize=20,
+        pagesize=None,
+        microtenant_id=None,
     ):
         """
         Fetches paginated data from the ZPA API based on specified parameters and handles various types of API pagination.
@@ -417,15 +432,19 @@ class ZPAClientHelper(ZPAClient):
         if params is None:
             params = {}
 
-        if (page is not None or pagesize != 20) and (max_pages is not None or max_items is not None):
+        if (page is not None or pagesize is not None) and (max_pages is not None or max_items is not None):
             raise ValueError(
                 "Do not mix 'page' or 'pagesize' with 'max_pages' or 'max_items'. Choose either set of parameters."
             )
 
-        params["pagesize"] = min(pagesize, 500)  # Apply maximum constraint and handle default
+        params["page"] = page if page is not None else 1  # Default to page 1 if not specified
+        params["pagesize"] = min(pagesize if pagesize is not None else 20, 500)  # Apply maximum constraint and handle default
 
-        if page:
-            params["page"] = page
+        # Check for microtenantId in function arguments first, then environment variable
+        if microtenant_id:
+            params["microtenantId"] = microtenant_id
+        elif self.microtenant_id and "microtenantId" not in params:
+            params["microtenantId"] = self.microtenant_id
 
         if search:
             api_search_field = snake_to_camel(search_field)
@@ -443,6 +462,10 @@ class ZPAClientHelper(ZPAClient):
             params["idpGroupId"] = idp_group_id
         if scim_user_id:
             params["scimUserId"] = scim_user_id
+        if scim_username:
+            params["scimUserName"] = scim_username
+        if all_entries:
+            params["allEntries"] = all_entries
 
         total_collected = 0
         ret_data = []
@@ -456,17 +479,18 @@ class ZPAClientHelper(ZPAClient):
                 if should_wait:
                     time.sleep(delay)
 
-                url = f"{path}?{urllib.parse.urlencode(params)}"
-                response = self.send("GET", url, api_version=api_version)
+                response = self.send("GET", path=path, params=params, api_version=api_version)
 
                 if response.status_code != expected_status_code:
-                    error_msg = ERROR_MESSAGES["UNEXPECTED_STATUS"].format(status_code=response.status_code, page=page)
+                    error_msg = ERROR_MESSAGES["UNEXPECTED_STATUS"].format(
+                        status_code=response.status_code, page=params["page"]
+                    )
                     logger.error(error_msg)
                     return BoxList([]), error_msg
 
                 response_data = response.json()
                 data = response_data.get("list", [])
-                if not data and (page is None or page == 1):
+                if not data and (params["page"] == 1):
                     error_msg = ERROR_MESSAGES["EMPTY_RESULTS"]
                     logger.warn(error_msg)
                     return BoxList([]), error_msg
@@ -478,12 +502,11 @@ class ZPAClientHelper(ZPAClient):
                 if max_items is not None and total_collected >= max_items:
                     break
 
-                nextPage = response_data.get("nextPage")
-                if not nextPage or (max_pages is not None and page >= max_pages):
+                next_page = response_data.get("nextPage")
+                if not next_page or (max_pages is not None and params["page"] >= max_pages):
                     break
 
-                page = nextPage if page is None else page + 1
-                params["page"] = page
+                params["page"] = next_page if params["page"] is None else params["page"] + 1
 
         finally:
             time.sleep(2)  # Ensure a delay between requests regardless of outcome
@@ -495,6 +518,14 @@ class ZPAClientHelper(ZPAClient):
 
         return BoxList(ret_data), None
 
+    @property
+    def authdomains(self):
+        """
+        The interface object for the :ref:`ZPA Auth Domains interface <zpa-authdomains>`.
+
+        """
+        return AuthDomainsAPI(self)
+
     @property
     def app_segments(self):
         """
@@ -591,6 +622,14 @@ class ZPAClientHelper(ZPAClient):
         """
         return MachineGroupsAPI(self)
 
+    @property
+    def microtenants(self):
+        """
+        The interface object for the :ref:`ZPA Microtenants interface <zpa-microtenants>`.
+
+        """
+        return MicrotenantsAPI(self)
+
     @property
     def policies(self):
         """