zscaler-sdk-python 1.9.26__tar.gz → 1.9.28__tar.gz

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.9.26
+Version: 1.9.28
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.9.26"
+version = "1.9.28"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "1.9.26"
+__version__ = "1.9.28"
 
 
 from zscaler.oneapi_client import Client as ZscalerClient  # noqa

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/utils.py

@@ -93,6 +93,11 @@ reformat_params = [
     ("supported_region_ids", "supportedRegions"),
     ("src_workload_groups_ids", "srcWorkloadGroups"),
     ("dest_workload_groups_ids", "destWorkloadGroups"),
+    ("application_ids", "applications"),
+    ("server_group_ids", "serverGroups"),
+    ("connector_ids", "connectors"),
+    ("server_group_ids", "serverGroups"),
+    ("user_portal_ids", "userPortals"),
 ]
 
 
@@ -225,54 +230,54 @@ def add_id_groups(id_groups: list, kwargs: dict, payload: dict):
     return
 
 
-def transform_common_id_fields(id_groups: list, source_dict: dict, target_dict: dict):
+def transform_common_id_fields(id_groups: list, source_dict: dict, target_dict: dict, coerce_ids: bool = True):
     """
-    For each (key, payload_key) in 'id_groups':
-      - If 'key' in source_dict, pop it out,
-      - convert that list/dict to the final "id" structure,
-      - store in target_dict[payload_key].
+    For each ``(key, payload_key)`` in ``id_groups``:
+
+    - If ``key`` is in ``source_dict``, pop it out,
+    - convert that list/dict to the final ``{"id": ...}`` structure,
+    - store the result in ``target_dict[payload_key]``.
+
+    Args:
+        id_groups: List of ``(snake_case_key, wire_key)`` tuples to remap.
+        source_dict: Dict to read (and pop) the snake-case keys from.
+        target_dict: Dict to write the wire-keyed, structured payload into.
+        coerce_ids: If ``True`` (default), numeric-looking string IDs are
+            coerced to ``int`` to match ZIA/ZTW APIs that strictly require
+            integer IDs. If ``False``, ID values are passed through verbatim
+            — required for ZPA, whose 19-digit string IDs must be preserved
+            on the wire (the API accepts both, but the canonical shape is
+            string and downstream JS clients lose precision on ints > 2^53).
     """
+
+    def _maybe_coerce(item_id):
+        if not coerce_ids:
+            return item_id
+        if isinstance(item_id, str):
+            try:
+                return int(item_id)
+            except ValueError:
+                return item_id
+        if isinstance(item_id, int):
+            return int(item_id)
+        return item_id
+
     for key, payload_key in id_groups:
         if key in source_dict:
             value = source_dict.pop(key)
             if isinstance(value, list):
-                # 1) Convert list-of-str-or-int => [{ "id":... }, ...]
                 final_list = []
                 for item in value:
                     if isinstance(item, (str, int)):
-                        # Try to convert to int, but keep as string if it's not a valid integer
-                        if isinstance(item, str):
-                            try:
-                                final_list.append({"id": int(item)})
-                            except ValueError:
-                                # Keep as string if it's not a valid integer (e.g., 'ihln05ktj07ds')
-                                final_list.append({"id": item})
-                        else:
-                            final_list.append({"id": int(item)})
+                        final_list.append({"id": _maybe_coerce(item)})
                     elif isinstance(item, dict) and "id" in item:
-                        # Possibly user gave { "id": 123, ... }
-                        if isinstance(item["id"], str):
-                            try:
-                                item["id"] = int(item["id"])
-                            except ValueError:
-                                # Keep as string if it's not a valid integer
-                                pass
-                        else:
-                            item["id"] = int(item["id"])
+                        item["id"] = _maybe_coerce(item["id"])
                         final_list.append(item)
                     else:
                         final_list.append(item)
                 target_dict[payload_key] = final_list
             elif isinstance(value, dict) and "id" in value:
-                # single dict with ID
-                if isinstance(value["id"], str):
-                    try:
-                        value["id"] = int(value["id"])
-                    except ValueError:
-                        # Keep as string if it's not a valid integer
-                        pass
-                else:
-                    value["id"] = int(value["id"])
+                value["id"] = _maybe_coerce(value["id"])
                 target_dict[payload_key] = value
     return
 

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zcc/models/forwardingprofile.py

@@ -129,9 +129,7 @@ class ForwardingProfileActions(ZscalerObject):
                 config["useTunnel2ForProxiedWebTraffic"] if "useTunnel2ForProxiedWebTraffic" in config else None
             )
             self.use_tunnel2_for_unencrypted_web_traffic = (
-                config["useTunnel2ForUnencryptedWebTraffic"]
-                if "useTunnel2ForUnencryptedWebTraffic" in config
-                else None
+                config["useTunnel2ForUnencryptedWebTraffic"] if "useTunnel2ForUnencryptedWebTraffic" in config else None
             )
             self.redirect_web_traffic = config["redirectWebTraffic"] if "redirectWebTraffic" in config else None
             self.drop_ipv6_include_traffic_in_t2 = (
@@ -381,9 +379,7 @@ class ForwardingProfile(ZscalerObject):
             self.dns_servers = config["dnsServers"] if "dnsServers" in config else None
             self.dns_search_domains = config["dnsSearchDomains"] if "dnsSearchDomains" in config else None
             self.hostname = config["hostname"] if "hostname" in config else None
-            self.resolved_ips_for_hostname = (
-                config["resolvedIpsForHostname"] if "resolvedIpsForHostname" in config else None
-            )
+            self.resolved_ips_for_hostname = config["resolvedIpsForHostname"] if "resolvedIpsForHostname" in config else None
             self.trusted_subnets = config["trustedSubnets"] if "trustedSubnets" in config else None
             self.trusted_gateways = config["trustedGateways"] if "trustedGateways" in config else None
             self.trusted_dhcp_servers = config["trustedDhcpServers"] if "trustedDhcpServers" in config else None
@@ -397,9 +393,7 @@ class ForwardingProfile(ZscalerObject):
             self.skip_trusted_criteria_match = (
                 config["skipTrustedCriteriaMatch"] if "skipTrustedCriteriaMatch" in config else None
             )
-            self.evaluate_trusted_network = (
-                config["evaluateTrustedNetwork"] if "evaluateTrustedNetwork" in config else None
-            )
+            self.evaluate_trusted_network = config["evaluateTrustedNetwork"] if "evaluateTrustedNetwork" in config else None
             self.predefined_trusted_networks = (
                 config["predefinedTrustedNetworks"] if "predefinedTrustedNetworks" in config else None
             )

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/app_segments_ba.py

@@ -19,7 +19,7 @@ from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.application_segment import ApplicationSegments
 from zscaler.zpa.app_segment_by_type import ApplicationSegmentByTypeAPI
-from zscaler.utils import format_url, add_id_groups
+from zscaler.utils import format_url, transform_common_id_fields
 from zscaler.types import APIResult
 import logging
 
@@ -294,7 +294,7 @@ class ApplicationSegmentBAAPI(APIClient):
         if "clientless_app_ids" in body:
             body["clientlessApps"] = body.pop("clientless_app_ids")
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
@@ -461,7 +461,7 @@ class ApplicationSegmentBAAPI(APIClient):
         else:
             body["udpPortRange"] = []  # Explicitly clear if not provided
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error:

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/app_segments_ba_v2.py

@@ -19,7 +19,7 @@ from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.application_segment import ApplicationSegments
 from zscaler.zpa.app_segment_by_type import ApplicationSegmentByTypeAPI
-from zscaler.utils import add_id_groups, format_url
+from zscaler.utils import format_url, transform_common_id_fields
 from zscaler.types import APIResult
 
 
@@ -279,8 +279,7 @@ class AppSegmentsBAV2API(APIClient):
             # Use format 2 (udpPortRange)
             body["udpPortRange"] = [{"from": pr["from"], "to": pr["to"]} for pr in body.pop("udp_port_range")]
 
-        # Apply add_id_groups to reformat params based on self.reformat_params
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
@@ -419,7 +418,7 @@ class AppSegmentsBAV2API(APIClient):
         else:
             body["udpPortRange"] = []  # Explicitly clear if not provided
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error:

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/app_segments_inspection.py

@@ -19,7 +19,7 @@ from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.application_segment import ApplicationSegments
 from zscaler.zpa.app_segment_by_type import ApplicationSegmentByTypeAPI
-from zscaler.utils import add_id_groups, format_url
+from zscaler.utils import format_url, transform_common_id_fields
 from zscaler.types import APIResult
 
 
@@ -267,10 +267,8 @@ class AppSegmentsInspectionAPI(APIClient):
             # Use format 2 (udpPortRange)
             body["udpPortRange"] = [{"from": pr["from"], "to": pr["to"]} for pr in body.pop("udp_port_range")]
 
-        # Apply add_id_groups to reformat params based on self.reformat_params
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
-        # Create the request
         request, error = self._request_executor.create_request(http_method, api_url, body=body)
         if error:
             return (None, None, error)
@@ -455,7 +453,7 @@ class AppSegmentsInspectionAPI(APIClient):
         else:
             body["udpPortRange"] = []  # Explicitly clear if not provided
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error:

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/app_segments_pra.py

@@ -19,7 +19,7 @@ from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.application_segment import ApplicationSegments
 from zscaler.zpa.app_segment_by_type import ApplicationSegmentByTypeAPI
-from zscaler.utils import add_id_groups, format_url
+from zscaler.utils import format_url, transform_common_id_fields
 from zscaler.types import APIResult
 
 
@@ -274,8 +274,7 @@ class AppSegmentsPRAAPI(APIClient):
             # Use format 2 (udpPortRange)
             body["udpPortRange"] = [{"from": pr["from"], "to": pr["to"]} for pr in body.pop("udp_port_range")]
 
-        # Apply add_id_groups to reformat params based on self.reformat_params
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
@@ -415,7 +414,7 @@ class AppSegmentsPRAAPI(APIClient):
         else:
             body["udpPortRange"] = []  # Explicitly clear if not provided
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error:

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/application_segment.py

@@ -22,6 +22,7 @@ from zscaler.zpa.models.application_segment_lb import WeightedLBConfig
 from zscaler.zpa.app_segment_by_type import ApplicationSegmentByTypeAPI
 from zscaler.zpa.models.application_segment import MultiMatchUnsupportedReferences
 from zscaler.utils import format_url, add_id_groups
+from zscaler.utils import format_url, transform_common_id_fields, reformat_params
 from zscaler.types import APIResult
 import logging
 
@@ -293,7 +294,7 @@ class ApplicationSegmentAPI(APIClient):
         if "clientless_app_ids" in body:
             body["clientlessApps"] = body.pop("clientless_app_ids")
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
@@ -452,7 +453,7 @@ class ApplicationSegmentAPI(APIClient):
         else:
             body["udpPortRange"] = []  # Explicitly clear if not provided
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error:

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/policies.py

@@ -19,7 +19,7 @@ from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.policyset_controller_v1 import PolicySetControllerV1
 from zscaler.zpa.models.policyset_controller_v2 import PolicySetControllerV2
-from zscaler.utils import format_url, add_id_groups
+from zscaler.utils import format_url, transform_common_id_fields
 from zscaler.types import APIResult
 from threading import Lock
 from functools import wraps
@@ -608,7 +608,7 @@ class PolicySetControllerAPI(APIClient):
         microtenant_id = body.get("microtenant_id", None)
         params = {"microtenantId": microtenant_id} if microtenant_id else {}
 
-        add_id_groups(self.reformat_params, kwargs, payload)
+        transform_common_id_fields(self.reformat_params, kwargs, payload, coerce_ids=False)
 
         conditions = kwargs.pop("conditions", [])
         if conditions:
@@ -700,7 +700,7 @@ class PolicySetControllerAPI(APIClient):
         }
 
         # Add remaining attributes from kwargs, transforming them to camel case
-        add_id_groups(self.reformat_params, kwargs, payload)
+        transform_common_id_fields(self.reformat_params, kwargs, payload, coerce_ids=False)
         conditions = kwargs.pop("conditions", [])
         if conditions:
             payload["conditions"] = self._create_conditions_v1(conditions)
@@ -1634,7 +1634,7 @@ class PolicySetControllerAPI(APIClient):
         microtenant_id = body.get("microtenant_id", None)
         params = {"microtenantId": microtenant_id} if microtenant_id else {}
 
-        add_id_groups(self.reformat_params, kwargs, payload)
+        transform_common_id_fields(self.reformat_params, kwargs, payload, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body=payload, params=params)
         if error:
@@ -1805,7 +1805,7 @@ class PolicySetControllerAPI(APIClient):
             "conditions": self._create_conditions_v2(kwargs.pop("conditions", [])),
         }
 
-        add_id_groups(self.reformat_params, kwargs, payload)
+        transform_common_id_fields(self.reformat_params, kwargs, payload, coerce_ids=False)
 
         microtenant_id = body.get("microtenant_id", None)
         params = {"microtenantId": microtenant_id} if microtenant_id else {}

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/server_groups.py

@@ -18,7 +18,7 @@ from typing import Dict, List, Optional, Any, Union
 from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.server_group import ServerGroup
-from zscaler.utils import format_url, add_id_groups
+from zscaler.utils import format_url, transform_common_id_fields
 from zscaler.types import APIResult
 
 
@@ -210,14 +210,13 @@ class ServerGroupsAPI(APIClient):
         microtenant_id = kwargs.get("microtenant_id") or body.get("microtenant_id", None)
         params = {"microtenantId": microtenant_id} if microtenant_id else {}
 
-        # Reformat server_group_ids to match the expected API format (serverGroups)
         if "app_connector_group_ids" in body:
             body["appConnectorGroups"] = [{"id": group_id} for group_id in body.pop("app_connector_group_ids")]
 
         if "server_ids" in body:
             body["servers"] = [{"id": group_id} for group_id in body.pop("server_ids")]
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
@@ -271,6 +270,14 @@ class ServerGroupsAPI(APIClient):
 
         body = existing_group.request_format()
 
+        # GET returns the full `applications` association on a server group, but the field is
+        # not required to update connector-group / server membership, and round-tripping it can
+        # exceed the API's payload-size cap on tenants where the group is associated with a
+        # large number of application segments (Issue #506). Drop it unless the caller is
+        # explicitly setting it via kwargs.
+        if "applications" not in kwargs:
+            body.pop("applications", None)
+
         body.update(kwargs)
 
         if "dynamicDiscovery" not in body:
@@ -285,7 +292,7 @@ class ServerGroupsAPI(APIClient):
         if "server_ids" in body:
             body["servers"] = [{"id": group_id} for group_id in body.pop("server_ids")]
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error:

{zscaler_sdk_python-1.9.26 → zscaler_sdk_python-1.9.28}/zscaler/zpa/user_portal_link.py

@@ -19,7 +19,7 @@ from zscaler.api_client import APIClient
 from zscaler.request_executor import RequestExecutor
 from zscaler.zpa.models.user_portal_link import UserPortalLink
 from zscaler.zpa.models.user_portal_link import UserPortalLinks
-from zscaler.utils import format_url, add_id_groups
+from zscaler.utils import format_url, transform_common_id_fields
 from zscaler.types import APIResult
 
 
@@ -199,7 +199,7 @@ class UserPortalLinkAPI(APIClient):
         if "user_portal_link_ids" in body:
             body["userPortals"] = [{"id": portal_link_id} for portal_link_id in body.pop("user_portal_link_ids")]
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
@@ -260,7 +260,7 @@ class UserPortalLinkAPI(APIClient):
         if "user_portal_link_ids" in body:
             body["userPortals"] = [{"id": portal_link_id} for portal_link_id in body.pop("user_portal_link_ids")]
 
-        add_id_groups(self.reformat_params, kwargs, body)
+        transform_common_id_fields(self.reformat_params, kwargs, body, coerce_ids=False)
 
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error: