zscaler-sdk-python 1.9.12__tar.gz → 1.9.13__tar.gz

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/PKG-INFO

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

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.9.12"
+version = "1.9.13"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -58,7 +58,7 @@ responses = ">=0.25.7"
 sphinx = ">=7.2.0"
 sphinx-autobuild = ">=2024.1.0"
 sphinx_rtd_theme = ">=1.3.0"
-wheel = ">=0.42.0"
+wheel = ">=0.46.0"
 
 [tool.poetry.extras]
 dev = ["black", "pytest", "pytest-asyncio", "pytest-mock", "pytest-recording", "pytest-cov", "pyfakefs", "isort", "wheel"]

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/utils.py

@@ -92,6 +92,7 @@ reformat_params = [
     ("scope_entity_ids", "adminScopeScopeEntities"),
     ("supported_region_ids", "supportedRegions"),
     ("src_workload_groups_ids", "srcWorkloadGroups"),
+    ("dest_workload_groups_ids", "destWorkloadGroups"),
 ]
 
 

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/zia/cloud_firewall.py

@@ -610,11 +610,13 @@ class FirewallResourcesAPI(APIClient):
         """
         )
 
+        query_params = query_params or {}
+
         body = {}
 
         body.update(kwargs)
 
-        request, error = self._request_executor.create_request(http_method, api_url, body, {}, {})
+        request, error = self._request_executor.create_request(http_method, api_url, body, {}, params=query_params)
         if error:
             return (None, None, error)
 

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/zia/rule_labels.py

@@ -277,3 +277,53 @@ class RuleLabelsAPI(APIClient):
         if error:
             return (None, response, error)
         return (None, response, None)
+
+    def get_rule_type_label(self, rule_type: str) -> APIResult[List[RuleLabels]]:
+        """
+        Retrieves a list of rule labels based on the specified rule type
+
+        Args:
+            rule_type (str): The type of rule to retrieve labels for. Only supported values are: URL_FILTERING, FIREWALL, CASB_DLP, CLOUD_APP_CONTROL, DATA_PROTECTION, GENAI, INDUSTRY_PEER, NEWS_FEED, RISK_SCORE, SANDBOX
+
+        Returns:
+            tuple: A tuple containing (list of Rule Labels instances, Response, error)
+
+        Examples:
+            Get Rule Labels for a specific rule type:
+
+            >>> fetched_labels, _, error = client.zia.rule_labels.get_rule_type_label('URL_FILTERING')
+            >>> if error:
+            ...     print(f"Error listing labels: {error}")
+            ...     return
+            ... print(f"Total labels found: {len(fetched_labels)}")
+            ... for label in fetched_labels:
+            ...     print(label.as_dict())
+        """
+        http_method = "get".upper()
+        api_url = format_url(
+            f"""
+            {self._zia_base_endpoint}
+            /ruleLabels/ruleType/{rule_type}
+        """
+        )
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+
+        if error:
+            return (None, response, error)
+
+        try:
+            result = []
+            for item in response.get_results():
+                result.append(RuleLabels(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/zia/sandbox.py

@@ -326,9 +326,8 @@ class CloudSandboxAPI(APIClient):
         Args:
             md5_hash_value_list (list[dict]): A list of MD5 hash entries to be blocked.
                 Each entry should be a dictionary with the following keys:
-                    - url (str): The MD5 hash value.
-                    - urlComment (str): A comment describing the hash.
-                    - type (str): The type of threat, e.g., "MALWARE".
+                ``url`` (str): The MD5 hash value.
+                ``type`` (str): The type of hash, e.g., ``CUSTOM_FILEHASH_DENY`` or ``CUSTOM_FILEHASH_ALLOW``.
                 Pass an empty list to clear the blocklist.
 
         Returns:
@@ -338,11 +337,8 @@ class CloudSandboxAPI(APIClient):
             Add MD5 hashes to the sandbox blocklist:
 
             >>> hash_list = [
-            ...     {
-            ...         "url": "42914d6d213a20a2684064be5c80ffa9",
-            ...         "urlComment": "Malicious file detected",
-            ...         "type": "MALWARE"
-            ...     }
+            ...     {"url": "35e38d023b253c0cd9bd3e16afc362a7", "type": "CUSTOM_FILEHASH_DENY"},
+            ...     {"url": "f6c1cf98076457e742937240b29132d2", "type": "CUSTOM_FILEHASH_ALLOW"},
             ... ]
             >>> result, response, error = client.zia.sandbox.add_hash_to_custom_list(
             ...     md5_hash_value_list=hash_list

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/ztw/forwarding_rules.py

@@ -114,7 +114,7 @@ class ForwardingControlRulesAPI(APIClient):
             order (str): The order of the rule, defaults to adding rule to bottom of list.
             rank (str): The admin rank of the rule. Supported values 1-7
             forward_method (str): The type of traffic forwarding method selected from the available options
-            Supported Values: `INVALID`, `DIRECT`, `PROXYCHAIN`, `ZIA`, `ZPA`, `ECZPA`, `ECSELF`, `DROP`
+            Supported Values: `INVALID`, `DIRECT`, `PROXYCHAIN`, `ZIA`, `ZPA`, `ECZPA`, `ECSELF`, `DROP`, `LOCAL_SWITCH`
 
             state (str): The rule state. Accepted values are 'ENABLED' or 'DISABLED'.
             description (str): Additional information about the rule
@@ -141,7 +141,8 @@ class ForwardingControlRulesAPI(APIClient):
             nw_application_groups (list): IDs for network application groups.
             device_groups (list): Device groups managed using Zscaler Client Connector.
             devices (list): Devices managed using Zscaler Client Connector.
-            src_workload_groups (list): IDs for source workload groups.
+            src_workload_groups_ids (list): IDs for source workload groups.
+            dest_workload_groups_ids (list): IDs for destination workload groups (Valid for LOCAL_SWITCH forward method).
 
             zpa_app_segments (list[dict]): **ZPA Application Segments applicable to the rule.**
                 - `external_id` (str): Indicates the external ID. Applicable only when this reference is of an external entity.
@@ -276,7 +277,8 @@ class ForwardingControlRulesAPI(APIClient):
             nw_application_groups (list): IDs for network application groups.
             device_groups (list): Device groups managed using Zscaler Client Connector.
             devices (list): Devices managed using Zscaler Client Connector.
-            src_workload_groups (list): IDs for source workload groups.
+            src_workload_groups_ids (list): IDs for source workload groups.
+            dest_workload_groups_ids (list): IDs for destination workload groups (Valid for LOCAL_SWITCH forward method).
 
             zpa_app_segments (list[dict]): **ZPA Application Segments applicable to the rule.**
                 - `external_id` (str): Indicates the external ID. Applicable only when this reference is of an external entity.

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/ztw/ip_destination_groups.py

@@ -289,6 +289,108 @@ class IPDestinationGroupsAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
+    def update_ip_destination_group(
+        self,
+        group_id: str,
+        query_params: Optional[dict] = None,
+        **kwargs
+    ) -> APIResult[dict]:
+        """
+        Updates the specified IP Destination Group.
+
+        Args:
+            query_params (dict):
+                Map of query parameters for the request.
+
+                ``[query_params.override]`` (bool): Indicates whether the IPs must be overridden.
+                    When set to false, the IPs are appended
+                    Else the existing IPs are overridden. The default value is true.
+
+            group_id (str): The unique ID of the IP Destination Group.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            name (str): The name of the IP Destination Group.
+            description (str): Additional information about the destination IP group.
+            type (str): Destination IP group type. Allowed values are DSTN_IP and DSTN_FQDN, DSTN_DOMAIN, DSTN_OTHER.
+            addresses (list): Destination IP addresses or FQDNs within the group.
+            ip_categories (list): Destination IP address URL categories. Note: Only Custom URL categories allowed.
+            countries (list): Destination IP address counties. i.e COUNTRY_CA, COUNTRY_US.
+
+        Returns:
+            :obj:`Tuple`: The updated IP Destination Group resource record.
+
+        Examples:
+            Update the name of an IP Destination Group:
+
+            >>> updated_group, _, error = client.ztw.ip_destination_groups.update_ip_destination_group(
+            ...     group_id='452125',
+            ...     name=f"UpdateGroup {random.randint(1000, 10000)}",
+            ...     description=f"UpdateGroup {random.randint(1000, 10000)}",
+            ...     addresses=["192.168.1.1", "192.168.1.2"],
+            ...     type="DSTN_IP"
+            ... )
+            >>> if error:
+            ...     print(f"Error updating group: {error}")
+            ...     return
+            ... print(f"Group updated successfully: {updated_group.as_dict()}")
+
+            Update the description and FQDNs for an IP Destination Group:
+
+            >>> updated_group, _, error = client.ztw.ip_destination_groups.update_ip_destination_group(
+            ...     group_id='452125',
+            ...     name=f"UpdateGroup_{random.randint(1000, 10000)}",
+            ...     description=f"UpdateGroup {random.randint(1000, 10000)}",
+            ...     addresses=['arstechnica.com', 'slashdot.org'],
+            ...     type="DSTN_FQDN",
+            ... )
+            >>> if error:
+            ...     print(f"Error updating group: {error}")
+            ...     return
+            ... print(f"Group updated successfully: {updated_group.as_dict()}")
+
+            Update a Destination IP Group with country and url category for the US:
+
+            >>> updated_group, _, error = client.ztw.ip_destination_groups.update_ip_destination_group(
+            ...    group_id='452125',
+            ...    name=f"UpdateGroup_{random.randint(1000, 10000)}",
+            ...    description=f"UpdateGroup_{random.randint(1000, 10000)}",
+            ...    type='DSTN_OTHER',
+            ...    countries=['COUNTRY_CA']),
+            ...    ip_categories=['CUSTOM_01']),
+            >>> if error:
+            ...     print(f"Error adding group: {error}")
+            ...     return
+            ... print(f"Group added successfully: {added_group.as_dict()}")
+        """
+        http_method = "put".upper()
+        api_url = format_url(
+            f"""
+            {self._ztw_base_endpoint}
+            /ipDestinationGroups/{group_id}
+        """
+        )
+
+        query_params = query_params or {}
+
+        body = {}
+
+        body.update(kwargs)
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, {}, params=query_params)
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, IPDestinationGroups)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = IPDestinationGroups(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
     def delete_ip_destination_group(self, group_id: int) -> APIResult[dict]:
         """
         Deletes the specified IP Destination Group.

{zscaler_sdk_python-1.9.12 → zscaler_sdk_python-1.9.13}/zscaler/ztw/models/forwarding_rules.py

@@ -129,6 +129,10 @@ class ForwardingControlRule(ZscalerObject):
                 config["srcWorkloadGroups"] if "srcWorkloadGroups" in config else [], common.CommonIDNameExternalID
             )
 
+            self.dest_workload_groups = ZscalerCollection.form_list(
+                config["destWorkloadGroups"] if "destWorkloadGroups" in config else [], common.CommonIDNameExternalID
+            )
+
             self.devices = ZscalerCollection.form_list(
                 config["devices"] if "devices" in config else [], common.CommonIDNameExternalID
             )
@@ -210,6 +214,7 @@ class ForwardingControlRule(ZscalerObject):
             self.zpa_application_segments = []
             self.zpa_application_segment_groups = []
             self.src_workload_groups = []
+            self.dest_workload_groups = []
             self.proxy_gateway = None
             self.zpa_gateway = None
             self.zpa_broker_rule = None
@@ -258,6 +263,7 @@ class ForwardingControlRule(ZscalerObject):
             "devices": [device.request_format() for device in (self.devices or [])],
             "deviceGroups": [dg.request_format() for dg in (self.device_groups or [])],
             "srcWorkloadGroups": [wg.request_format() for wg in (self.src_workload_groups or [])],
+            "destWorkloadGroups": [wg.request_format() for wg in (self.dest_workload_groups or [])],
             "zpaAppSegments": [zpa.request_format() for zpa in (self.zpa_app_segments or [])],
             "zpaApplicationSegments": [zpa_app.request_format() for zpa_app in (self.zpa_application_segments or [])],
             "zpaApplicationSegmentGroups": [

zscaler_sdk_python-1.9.13/zscaler/ztw/provisioning_url.py

@@ -0,0 +1,296 @@
+"""
+Copyright (c) 2023, Zscaler Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+"""
+
+from typing import Dict, List, Optional, Any, Union
+from zscaler.api_client import APIClient
+from zscaler.request_executor import RequestExecutor
+from zscaler.ztw.models.provisioning_url import ProvisioningURL
+from zscaler.utils import format_url
+from zscaler.types import APIResult
+
+
+class ProvisioningURLAPI(APIClient):
+    """
+    A Client object for the ProvisioningURLAPI resource.
+    """
+
+    _ztw_base_endpoint = "/ztw/api/v1"
+
+    def __init__(self, request_executor: "RequestExecutor") -> None:
+        super().__init__()
+        self._request_executor: RequestExecutor = request_executor
+
+    def list_provisioning_url(self, query_params: Optional[dict] = None) -> APIResult[List[ProvisioningURL]]:
+        """
+        List all provisioning URLs.
+
+        Keyword Args:
+            query_params {dict}: Optional query parameters.
+
+                ``[query_params.page]`` {int}: Specifies the page offset.
+
+                ``[query_params.page_size]`` {int}: Specifies the page size. The default size is 250.
+
+        Returns:
+            :obj:`Tuple`: The list of provisioning URLs.
+
+        Examples:
+            Print all provisioning URLs::
+
+                roles = ztw.provisioning.list_provisioning_url()
+                for role in roles:
+                    print(role)
+        """
+        http_method = "get".upper()
+        api_url = format_url(
+            f"""
+            {self._ztw_base_endpoint}
+            /provUrl
+        """
+        )
+
+        query_params = query_params or {}
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers, params=query_params)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+
+        if error:
+            return (None, response, error)
+
+        try:
+            result = []
+            for item in response.get_results():
+                result.append(ProvisioningURL(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def get_provisioning_url(self, provision_id: str) -> APIResult[dict]:
+        """
+        Get details for a provisioning template by ID.
+
+        Args:
+            provision_id (str): ID of Cloud & Branch Connector provisioning template.
+
+        Returns:
+            :obj:`Tuple`: The provisiong template url details.
+
+        Examples:
+            Print the details of a provisioning template url:
+
+                print(ztw.provisioning.get_provisioning_url("123456789")
+
+        """
+        http_method = "get".upper()
+        api_url = format_url(
+            f"""
+            {self._ztw_base_endpoint}
+            /provUrl/{provision_id}
+        """
+        )
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, ProvisioningURL)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = ProvisioningURL(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def add_provisioning_url(self, **kwargs) -> APIResult[dict]:
+        """
+        Adds a new Provisioning URL.
+
+        Args:
+            name (str): The name of the provisioning URL.
+            desc (str): Additional information for the provisioning URL.
+            prov_url_type (str): The type of provisioning URL. Supported values: ``CLOUD``, ``BRANCH``.
+            prov_url_data (dict): The provisioning URL data containing:
+                - location_template (dict): Location template with ``id``.
+                - cloud_provider_type (str): Cloud provider type (e.g., ``AWS``, ``AZURE``, ``GCP``).
+                - form_factor (str): Form factor (e.g., ``SMALL``, ``MEDIUM``, ``LARGE``).
+                - release_channel (str): Release channel (e.g., ``LATEST``, ``STABLE``).
+
+        Returns:
+            tuple: The new provisioning URL resource record.
+
+        Examples:
+            Add a new provisioning URL:
+
+            >>> added_prov_url, _, error = client.ztw.provisioning_url.add_provisioning_url(
+            ...     name="AWS_CAN02",
+            ...     desc="AWS_CAN02_Description",
+            ...     prov_url_type="CLOUD",
+            ...     prov_url_data={
+            ...         "location_template": {
+            ...             "id": 82521
+            ...         },
+            ...         "cloud_provider_type": "AWS",
+            ...         "form_factor": "SMALL",
+            ...         "release_channel": "LATEST"
+            ...     }
+            ... )
+            >>> if error:
+            ...     print(f"Error adding provisioning URL: {error}")
+            ...     return
+            ... print(f"Provisioning URL added successfully: {added_prov_url.as_dict()}")
+
+        """
+        http_method = "post".upper()
+        api_url = format_url(
+            f"""
+            {self._ztw_base_endpoint}
+            /provUrl
+        """
+        )
+
+        body = kwargs
+
+        request, error = self._request_executor.create_request(
+            method=http_method,
+            endpoint=api_url,
+            body=body,
+        )
+
+        if error:
+            return (None, None, error)
+
+        # Execute the request
+        response, error = self._request_executor.execute(request, ProvisioningURL)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = ProvisioningURL(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def update_provisioning_url(self, provision_id: int, **kwargs) -> APIResult[dict]:
+        """
+        Updates information for the specified Provisioning URL.
+
+        Args:
+            provision_id (int): The unique ID for the Provisioning URL.
+            name (str): The name of the provisioning URL.
+            desc (str): Additional information for the provisioning URL.
+            prov_url_type (str): The type of provisioning URL. Supported values: ``CLOUD``, ``BRANCH``.
+            prov_url_data (dict): The provisioning URL data containing:
+                - location_template (dict): Location template with ``id``.
+                - cloud_provider_type (str): Cloud provider type (e.g., ``AWS``, ``AZURE``, ``GCP``).
+                - form_factor (str): Form factor (e.g., ``SMALL``, ``MEDIUM``, ``LARGE``).
+                - release_channel (str): Release channel (e.g., ``LATEST``, ``STABLE``).
+
+        Returns:
+            tuple: A tuple containing the updated Provisioning URL, response, and error.
+
+        Examples:
+            Update an existing Provisioning URL:
+
+            >>> updated_prov_url, _, error = client.ztw.provisioning_url.update_provisioning_url(
+            ...     provision_id=added_prov_url.id,
+            ...     name="AWS_CAN02",
+            ...     desc="AWS_CAN02_Updated_Description",
+            ...     prov_url_type="CLOUD",
+            ...     prov_url_data={
+            ...         "location_template": {
+            ...             "id": 82521
+            ...         },
+            ...         "cloud_provider_type": "AWS",
+            ...         "form_factor": "SMALL",
+            ...         "release_channel": "LATEST"
+            ...     }
+            ... )
+            >>> if error:
+            ...     print(f"Error updating provisioning URL: {error}")
+            ...     return
+            ... print(f"Provisioning URL updated successfully: {updated_prov_url.as_dict()}")
+        """
+        http_method = "put".upper()
+        api_url = format_url(
+            f"""
+            {self._ztw_base_endpoint}
+            /provUrl/{provision_id}
+        """
+        )
+        body = kwargs
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, {}, {})
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, ProvisioningURL)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = ProvisioningURL(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def delete_provisioning_url(self, provision_id: int) -> APIResult[dict]:
+        """
+        Deletes a provisioning URL.
+
+        Args:
+            provision_id (str): The unique ID of the provisioning URL to be deleted.
+
+        Returns:
+            :obj:`int`: The status code for the operation.
+
+        Examples:
+            >>> _, response, error = client.ztw.provisioning.delete_provisioning_url('545845')
+            ... if error:
+            ...     print(f"Error deleting provisioning URL: {error}")
+            ... return
+
+        """
+        http_method = "delete".upper()
+        api_url = format_url(
+            f"""
+            {self._ztw_base_endpoint}
+            /provUrl/{provision_id}
+        """
+        )
+
+        params = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, params=params)
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+        if error:
+            return (None, response, error)
+        return (None, response, None)