zscaler-sdk-python 1.0.0__py2.py3-none-any.whl

zscaler/zpa/inspection.py

@@ -0,0 +1,1012 @@
+# -*- coding: utf-8 -*-
+
+# 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 box import Box, BoxList
+from requests import Response
+from requests.utils import quote
+
+from zscaler.utils import convert_keys, snake_to_camel
+from zscaler.zpa.client import ZPAClient
+
+
+class InspectionControllerAPI:
+    def __init__(self, client: ZPAClient):
+        self.rest = client
+
+    @staticmethod
+    def _create_rule(rule: dict) -> dict:
+        rule_set = {
+            "type": rule["type"],
+            "conditions": [],
+        }
+        if "names" in rule:
+            rule_set["names"] = rule["names"]
+        for condition in rule["conditions"]:
+            rule_set["conditions"].append(
+                {
+                    "lhs": condition["lhs"],
+                    "op": condition["op"],
+                    "rhs": condition["rhs"],
+                }
+            )
+        return rule_set
+
+    def add_custom_control(
+        self,
+        name: str,
+        default_action: str,
+        severity: str,
+        type: str,
+        rules: list,
+        **kwargs,
+    ) -> Box:
+        """
+        Adds a new ZPA Inspection Custom Control.
+
+        Args:
+            name (str): The name of the custom control.
+            default_action (str): The default action to take for matches against this custom control.
+            severity (str): The severity for events that match this custom control.
+            type (str): The type of HTTP message this control matches.
+            rules (list): A list of Inspection Control rule objects.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            description (str): Additional information about the custom control.
+            paranoia_level (int): The paranoia level for the custom control.
+
+        Returns:
+            :obj:`Box`: The newly created custom Inspection Control resource record.
+
+        """
+
+        payload = {
+            "name": name,
+            "defaultAction": default_action,
+            "severity": severity,
+            "rules": [],
+            "type": type,
+        }
+
+        # Handle default_action_value
+        if "default_action_value" in kwargs:
+            payload["defaultActionValue"] = kwargs["default_action_value"]
+
+        # Use the _create_rule method to restructure the Inspection Control rule and add to the payload.
+        for rule in rules:
+            payload["rules"].append(self._create_rule(rule))
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            if key == "paranoia_level":
+                payload["paranoiaLevel"] = int(value)
+            elif key == "description":
+                payload["description"] = value
+            # Add other optional parameters if necessary
+
+            # Convert snake to camelcase
+            payload = convert_keys(payload)
+
+        response = self.rest.post("inspectionControls/custom", json=payload)
+        if isinstance(response, Response):
+            # this is only true when the creation failed (status code is not 2xx)
+            status_code = response.status_code
+            # Handle error response
+            raise Exception(
+                f"API call failed with status {status_code}: {response.json()}"
+            )
+        return response
+
+        # response = self.rest.post("/inspectionControls/custom", json=payload)
+        # if isinstance(response, Response):
+        #     status_code = response.status_code
+        #     if status_code > 299:
+        #         return None
+        # return self.get_custom_control(response.get("id"))
+
+    def add_profile(
+        self, name: str, paranoia_level: int, predef_controls_version: str, **kwargs
+    ):
+        """
+        Adds a ZPA Inspection Profile.
+
+        Args:
+            name (str):
+                The name of the Inspection Profile.
+            paranoia_level (int):
+                The paranoia level for the Inspection Profile.
+            predef_controls_version (str):
+                The version of the predefined controls that will be added.
+            **kwargs:
+                Additional keyword args.
+
+        Keyword Args:
+            **description (str):
+                Additional information about the Inspection Profile.
+            **custom_controls (list):
+                A tuple list of custom controls to be added to the Inspection profile.
+
+                Custom control tuples must follow the convention below:
+
+                ``(control_id, action)``
+
+                e.g.
+
+                .. code-block:: python
+
+                    custom_controls = [(99999, "BLOCK"), (88888, "PASS")]
+            **predef_controls (list):
+                A tuple list of predefined controls to be added to the Inspection profile.
+
+                Predefined control tuples must follow the convention below:
+
+                ``(control_id, action)``
+
+                e.g.
+
+                .. code-block:: python
+
+                    predef_controls = [(77777, "BLOCK"), (66666, "PASS")]
+
+        Returns:
+            :obj:`Box`: The newly created Inspection Profile resource record.
+
+        Examples:
+            Add a new ZPA Inspection Profile with the minimum required parameters, printing the object to
+            console after creation:
+
+            .. code-block:: python
+
+                print(
+                    zpa.inspection.add_profile(
+                        name="predefined_controls",
+                        paranoia_level=3,
+                        predef_controls_version="OWASP_CRS/3.3.0",
+                    )
+                )
+
+            Add a new ZPA Inspection Profile that uses additional predefined controls and custom controls, printing the
+            object to console after creation:
+
+            .. code-block:: python
+
+                print(
+                    zpa.inspection.add_profile(
+                        name="block_common_xss",
+                        paranoia_level=2,
+                        predefined_controls=[("99999", "BLOCK")],
+                        predef_controls_version="OWASP_CRS/3.3.0",
+                        custom_controls=[("88888", "BLOCK")],
+                    )
+                )
+
+        """
+
+        # Inspection Profiles require the default predefined controls to be added. zscaler-sdk-python adds these in
+        # automatically for our users.
+
+        predef_controls = self.list_predef_controls("OWASP_CRS/3.3.0")
+        default_controls = []
+        for group in predef_controls:
+            if group.default_group:
+                default_controls = group.predefined_inspection_controls
+
+        payload = {
+            "name": name,
+            "paranoiaLevel": paranoia_level,
+            "predefinedControls": default_controls,
+            "predefinedControlsVersion": predef_controls_version,
+        }
+
+        # Extend existing list of default predefined controls if the user supplies more
+        if kwargs.get("predef_controls"):
+            controls = kwargs.pop("predef_controls")
+            for control in controls:
+                payload["predefinedControls"].append(
+                    {"id": control[0], "action": control[1]}
+                )
+
+        # Add custom controls if provided
+        if kwargs.get("custom_controls"):
+            controls = kwargs.pop("custom_controls")
+            payload["customControls"] = [
+                {"id": control[0], "action": control[1]} for control in controls
+            ]
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[key] = value
+
+        payload = convert_keys(payload)
+
+        response = self.rest.post("inspectionProfile", json=payload)
+        if isinstance(response, Response):
+            # this is only true when the creation failed (status code is not 2xx)
+            status_code = response.status_code
+            # Handle error response
+            raise Exception(
+                f"API call failed with status {status_code}: {response.json()}"
+            )
+        return response
+
+        # response = self.rest.post("/inspectionProfile", json=payload)
+        # if isinstance(response, Response):
+        #     status_code = response.status_code
+        #     if status_code > 299:
+        #         return None
+        # return self.get_profile(response.get("id"))
+
+    def delete_custom_control(self, control_id: str) -> int:
+        """
+        Deletes the specified custom ZPA Inspection Control.
+
+        Args:
+            control_id (str):
+                The unique id for the custom control that will be deleted.
+
+        Returns:
+            :obj:`int`: The status code for the operation.
+
+        Examples:
+            Delete a custom ZPA Inspection Control with an id of `99999`.
+
+            .. code-block:: python
+
+                zpa.inspection.delete_custom_control("99999")
+
+        """
+        return self.rest.delete(f"inspectionControls/custom/{control_id}").status_code
+
+    def delete_profile(self, profile_id: str):
+        """
+        Deletes the specified Inspection Profile.
+
+        Args:
+            profile_id (str):
+                The unique id for the Inspection Profile that will be deleted.
+
+        Returns:
+            :obj:`int`: The status code for the operation.
+
+        Examples:
+            Delete an Inspection Profile with an id of *999999*:
+
+            .. code-block:: python
+
+                zpa.inspection.delete_profile("999999")
+
+        """
+        return self.rest.delete(f"inspectionProfile/{profile_id}").status_code
+
+    def get_custom_control(self, control_id: str) -> Box:
+        """
+        Returns the specified custom ZPA Inspection Control.
+
+        Args:
+            control_id (str):
+                The unique id of the custom ZPA Inspection Control to be returned.
+
+        Returns:
+            :obj:`Box`: The custom ZPA Inspection Control resource record.
+
+        Examples:
+            Print the Custom Inspection Control with an id of `99999`:
+
+            .. code-block:: python
+
+                print(zpa.inspection.get_custom_control("99999"))
+
+        """
+        response = self.rest.get("/inspectionControls/custom/%s" % (control_id))
+        if isinstance(response, Response):
+            status_code = response.status_code
+            if status_code != 200:
+                return None
+        return response
+
+    def get_predef_control(self, control_id: str):
+        """
+        Returns the specified predefined ZPA Inspection Control.
+
+        Args:
+            control_id (str):
+                The unique id of the predefined ZPA Inspection Control to be returned.
+
+        Returns:
+            :obj:`Box`: The ZPA Inspection Predefined Control resource record.
+
+        Examples:
+            Print the ZPA Inspection Predefined Control with an id of `99999`:
+
+            .. code-block:: python
+
+                print(zpa.inspection.get_predef_control("99999"))
+
+        """
+        response = self.rest.get("/inspectionControls/predefined/%s" % (control_id))
+        if isinstance(response, Response):
+            status_code = response.status_code
+            if status_code != 200:
+                return None
+        return response
+
+    def get_profile(self, profile_id: str) -> Box:
+        """
+        Returns the specified ZPA Inspection Profile.
+
+        Args:
+            profile_id (str):
+                The unique id of the ZPA Inspection Profile
+
+        Returns:
+            :obj:`Box`: The specified ZPA Inspection Profile resource record.
+
+        Examples:
+            Print the ZPA Inspection Profile with an id of `99999`:
+
+            .. code-block:: python
+
+                print(zpa.inspection.get_profile("99999"))
+
+        """
+        response = self.rest.get("/inspectionProfile/%s" % (profile_id))
+        if isinstance(response, Response):
+            status_code = response.status_code
+            if status_code != 200:
+                return None
+        return response
+
+    def list_control_action_types(self) -> Box:
+        """
+        Returns a list of ZPA Inspection Control Action Types.
+
+        Returns:
+            :obj:`BoxList`: A list containing the ZPA Inspection Control Action Types.
+
+        Examples:
+            Iterate over the ZPA Inspection Control Action Types and print each one:
+
+            .. code-block:: python
+
+                for action_type in zpa.inspection.list_control_action_types():
+                    print(action_type)
+
+        """
+        return self.rest.get("inspectionControls/actionTypes")
+
+    def list_control_severity_types(self) -> BoxList:
+        """
+        Returns a list of Inspection Control Severity Types.
+
+        Returns:
+            :obj:`BoxList`: A list containing all valid Inspection Control Severity Types.
+
+        Examples:
+            Print all Inspection Control Severity Types
+
+            .. code-block:: python
+
+                for severity in zpa.inspection.list_control_severity_types():
+                    print(severity)
+
+        """
+        return self.rest.get("inspectionControls/severityTypes")
+
+    def list_control_types(self) -> BoxList:
+        """
+        Returns a list of ZPA Inspection Control Types.
+
+        Returns:
+            :obj:`BoxList`: A list containing ZPA Inspection Control Types.
+
+        Examples:
+            Print all ZPA Inspection Control Types:
+
+            .. code-block:: python
+
+                for control_type in zpa.inspection.list_control_types():
+                    print(control_type)
+
+        """
+        return self.rest.get("inspectionControls/controlTypes")
+
+    def list_custom_control_types(self) -> BoxList:
+        """
+        Returns a list of custom ZPA Inspection Control Types.
+
+        Returns:
+            :obj:`BoxList`: A list containing custom ZPA Inspection Control Types.
+
+        Examples:
+
+            Print all custom ZPA Inspection Control Types
+
+            .. code-block:: python
+
+                for control_type in zpa.inspection.list_custom_control_types():
+                    print(control_type)
+
+        """
+        return self.rest.get(
+            "https://config.private.zscaler.com/mgmtconfig/v1/admin/inspectionControls/customControlTypes"
+        )
+
+    def list_custom_controls(self, **kwargs) -> BoxList:
+        """
+        Returns a list of all custom ZPA Inspection Controls.
+
+        Args:
+            **kwargs: Optional keyword arguments.
+
+        Keyword Args:
+            **search (str):
+                The string used to search for a custom control by features and fields.
+            **sortdir (str):
+                Specifies the sorting order for the search results.
+
+                Accepted values are:
+
+                - ``ASC`` - ascending order
+                - ``DESC`` - descending order
+
+        Returns:
+            :obj:`BoxList`: A list containing all custom ZPA Inspection Controls.
+
+        Examples:
+            Print a list of all custom ZPA Inspection Controls:
+
+            .. code-block:: python
+
+                for control in zpa.inspection.list_custom_controls():
+                    print(control)
+
+        """
+        list, _ = self.rest.get_paginated_data(
+            path="/inspectionControls/custom",
+        )
+        return list
+
+    def list_custom_http_methods(self) -> BoxList:
+        """
+        Returns a list of custom ZPA Inspection Control HTTP Methods.
+
+        Returns:
+            :obj:`BoxList`: A list containing custom ZPA Inspection Control HTTP Methods.
+
+        Examples:
+
+            Print all custom ZPA Inspection Control HTTP Methods:
+
+            .. code-block:: python
+
+                for method in zpa.inspection.list_custom_http_methods():
+                    print(method)
+
+        """
+        return self.rest.get("inspectionControls/custom/httpMethods")
+
+    def list_predef_control_versions(self) -> BoxList:
+        """
+        Returns a list of predefined ZPA Inspection Control versions.
+
+        Returns:
+            :obj:`BoxList`: A list containing all predefined ZPA Inspection Control versions.
+
+        Examples:
+            Print all predefined ZPA Inspection Control versions::
+
+                for version in zpa.inspection.list_predef_control_versions():
+                    print(version)
+
+        """
+        return self.rest.get("inspectionControls/predefined/versions")
+
+    def list_predef_controls(self, version: str, **kwargs) -> BoxList:
+        """
+        Returns a list of predefined ZPA Inspection Controls.
+
+        Args:
+            version (str):
+                The version of the predefined controls to return.
+            **kwargs:
+                Optional keyword args.
+
+        Keyword Args:
+            **search (str):
+                The string used to search for predefined inspection controls by features and fields.
+
+        Returns:
+            :obj:`BoxList`: A list containing all predefined ZPA Inspection Controls that match the Version and Search
+            string.
+
+        Examples:
+            Return all predefined ZPA Inspection Controls for the given version:
+
+            .. code-block:: python
+
+                for control in zpa.inspection.list_predef_controls(version="OWASP_CRS/3.3.0"):
+                    print(control)
+
+            Return predefined ZPA Inspection Controls matching a search string:
+
+            .. code-block:: python
+
+                for control in zpa.inspection.list_predef_controls(search="new_control", version="OWASP_CRS/3.3.0"):
+                    print(control)
+
+        """
+        # Encode the version parameter to be URL safe
+        encoded_version = quote(version, safe="")
+
+        # Construct the full URL with version query param
+        url = f"/inspectionControls/predefined?version={encoded_version}"
+
+        # If you have additional query parameters, add them to the URL
+        if kwargs:
+            additional_params = "&".join(
+                f"{key}={quote(str(value))}" for key, value in kwargs.items()
+            )
+            url += f"&{additional_params}"
+
+        # Make the GET request
+        response = self.rest.get(url)
+        if isinstance(response, Response):
+            status_code = response.status_code
+            if status_code != 200:
+                # Handle error or return None based on your API handling
+                return None
+        return response
+
+    def get_predef_control_by_name(
+        self, name: str, version: str = "OWASP_CRS/3.3.0"
+    ) -> Box:
+        """
+        Returns the specified predefined ZPA Inspection Control by its name.
+
+        Args:
+            name (str):
+                The name of the predefined ZPA Inspection Control to be returned.
+            version (str):
+                The version of the predefined control to return.
+
+        Returns:
+            :obj:`Box`: The ZPA Inspection Predefined Control resource record.
+
+        Examples:
+            Print the ZPA Inspection Predefined Control with the name `Failed to parse request body`:
+
+            .. code-block:: python
+
+                print(zpa.inspection.get_predef_control_by_name("Failed to parse request body", "OWASP_CRS/3.3.0"))
+
+        """
+        # Use the list_predef_controls method to get all controls
+        all_controls = self.list_predef_controls(version)
+
+        # Iterate through the controls to find the one with the desired name
+        for control_group in all_controls:
+            for control in control_group.get("predefined_inspection_controls", []):
+                if control["name"] == name:
+                    return control
+
+        # If we reach here, the control was not found
+        raise ValueError(f"No predefined control named '{name}' found")
+
+    def get_predef_control_group_by_name(
+        self, group_name: str, version: str = "OWASP_CRS/3.3.0"
+    ) -> Box:
+        """
+        Returns the specified predefined ZPA Inspection Control Group by its name.
+
+        Args:
+            group_name (str):
+                The name of the predefined ZPA Inspection Control Group to be returned.
+            version (str):
+                The version of the predefined control to return.
+
+        Returns:
+            :obj:`Box`: The ZPA Inspection Predefined Control Group resource record.
+
+        Examples:
+            Print the ZPA Inspection Predefined Control Group with the name `Preprocessors`:
+
+            .. code-block:: python
+
+                print(zpa.inspection.get_predef_control_group_by_name("Preprocessors", "OWASP_CRS/3.3.0"))
+
+        """
+        # Use the list_predef_controls method to get all control groups
+        all_control_groups = self.list_predef_controls(version)
+
+        # Iterate through the control groups to find the one with the desired name
+        for control_group in all_control_groups:
+            if control_group["control_group"] == group_name:
+                return control_group
+
+        # If we reach here, the control group was not found
+        raise ValueError(f"No predefined control group named '{group_name}' found")
+
+    def list_profiles(self, **kwargs) -> BoxList:
+        """
+        Returns the list of ZPA Inspection Profiles.
+
+        Args:
+            **kwargs:
+                Optional keyword args.
+
+        Keyword Args:
+            **pagesize (int):
+                Specifies the page size. The default size is 20 and the maximum size is 500.
+            **search (str, optional):
+                The search string used to match against features and fields.
+
+        Returns:
+            :obj:`BoxList`: The list of ZPA Inspection Profile resource records.
+
+        Examples:
+            Iterate over all ZPA Inspection Profiles and print them:
+
+            .. code-block:: python
+
+                for profile in zpa.inspection.list_profiles():
+                    print(profile)
+
+        """
+        list, _ = self.rest.get_paginated_data(
+            path="/inspectionProfile",
+        )
+        return list
+
+    def profile_control_attach(self, profile_id: str, action: str, **kwargs) -> Box:
+        """
+        Attaches or detaches all predefined ZPA Inspection Controls to a ZPA Inspection Profile.
+
+        Args:
+            profile_id (str):
+                The unique id for the ZPA Inspection Profile that will be modified.
+            action (str):
+                The association action that will be taken, accepted values are:
+
+                * ``attach``: Attaches all predefined controls to the Inspection Profile with the specified version.
+                * ``detach``: Detaches all predefined controls from the Inspection Profile.
+            **kwargs:
+                Additional keyword arguments.
+
+        Keyword Args:
+            profile_version (str):
+                The version of the Predefined Controls to attach. Only required when using the
+                attach action. Defaults to ``OWASP_CRS/3.3.0``.
+
+        Returns:
+            :obj:`Box`: The updated ZPA Inspection Profile resource record.
+
+        Examples:
+            Attach all predefined controls to a ZPA Inspection Profile with an id of 99999:
+
+            .. code-block:: python
+
+                updated_profile = zpa.inspection.profile_control_attach("99999", action="attach")
+
+            Attach all predefined controls to a ZPA Inspection Profile with an id of 99999 and specified version:
+
+            .. code-block:: python
+
+                updated_profile = zpa.inspection.profile_control_attach(
+                    "99999",
+                    action="attach",
+                    profile_version="OWASP_CRS/3.2.0",
+                )
+
+            Detach all predefined controls from a ZPA Inspection Profile with an id of 99999:
+
+            .. code-block:: python
+
+                updated_profile = zpa.inspection.profile_control_attach(
+                    "99999",
+                    action="detach",
+                )
+
+        Raises:
+            ValueError: If an incorrect value is supplied for `action`.
+
+        """
+        if action == "attach":
+            payload = {"version": kwargs.pop("profile_version", "OWASP_CRS/3.3.0")}
+            resp = self.rest.put(
+                f"inspectionProfile/{profile_id}/associateAllPredefinedControls",
+                params=payload,
+            )
+            return (
+                self.get_profile(profile_id)
+                if resp.status_code == 204
+                else resp.status_code
+            )
+        elif action == "detach":
+            resp = self.rest.put(
+                f"inspectionProfile/{profile_id}/deAssociateAllPredefinedControls"
+            )
+            return (
+                self.get_profile(profile_id)
+                if resp.status_code == 204
+                else resp.status_code
+            )
+        else:
+            raise ValueError(
+                "Unknown action provided. Valid actions are 'attach' or 'detach'."
+            )
+
+    def update_custom_control(self, control_id: str, **kwargs) -> Box:
+        """
+        Updates the specified custom ZPA Inspection Control.
+
+        Args:
+            control_id (str):
+                The unique id for the custom control that will be updated.
+            **kwargs:
+                Optional keyword args.
+
+        Keyword Args:
+            **description (str):
+                Additional information about the custom control.
+            **default_action (str):
+                The default action to take for matches against this custom control. Valid options are:
+
+                - ``PASS``
+                - ``BLOCK``
+                - ``REDIRECT``
+            **name (str):
+                The name of the custom control.
+            **paranoia_level (int):
+                The paranoia level for the custom control.
+            **rules (list):
+                A list of Inspection Control rule objects, with each object using the format::
+
+                    {
+                        "names": ["name1", "name2"],
+                        "type": "rule_type",
+                        "conditions": [
+                            ("LHS", "OP", "RHS"),
+                            ("LHS", "OP", "RHS"),
+                        ],
+                    }
+            **severity (str):
+                The severity for events that match this custom control. Valid options are:
+
+                - ``CRITICAL``
+                - ``ERROR``
+                - ``WARNING``
+                - ``INFO``
+            **type (str):
+                The type of HTTP message this control matches. Valid options are:
+
+                - ``REQUEST``
+                - ``RESPONSE``
+
+        Returns:
+            :obj:`Box`: The updated custom ZPA Inspection Control resource record.
+
+        Examples:
+            Update the description of a custom ZPA Inspection Control with an id of 99999:
+
+            .. code-block:: python
+
+                print(
+                    zpa.inspection.update_custom_control(
+                        "99999",
+                        description="Updated description",
+                    )
+                )
+
+            Update the rules of a custom ZPA Inspection Control with an id of 88888:
+
+            .. code-block:: python
+
+                print(
+                    zpa.inspection.update_custom_control(
+                        "88888",
+                        rules=[
+                            {
+                                "names": ["xforwardedfor_ge_20"],
+                                "type": "REQUEST_HEADERS",
+                                "conditions": [
+                                    ("SIZE", "GE", "20"),
+                                    ("VALUE", "CONTAINS", "X-Forwarded-For"),
+                                ],
+                            }
+                        ],
+                    )
+                )
+
+
+        """
+
+        # Set payload to value of existing record and recursively convert nested dict keys from snake_case
+        # to camelCase.
+        payload = convert_keys(self.get_custom_control(control_id))
+
+        # If the user provides rules for an update, clear the current rules then use the create_rule method to
+        # restructure the Inspection Control rule and add to the payload.
+        if kwargs.get("rules"):
+            payload["rules"] = []
+            for rule in kwargs.pop("rules"):
+                payload["rules"].append(self._create_rule(rule))
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload_key = snake_to_camel(key)
+            payload[payload_key] = value
+
+            # Special handling for default_action_value
+            if key == "default_action_value":
+                payload["defaultActionValue"] = value
+
+        resp = self.rest.put(
+            f"inspectionControls/custom/{control_id}", json=payload
+        ).status_code
+
+        # Return the object if it was updated successfully
+        if not isinstance(resp, Response):
+            return self.get_custom_control(control_id)
+
+    def update_profile(self, profile_id: str, **kwargs):
+        """
+        Updates the specified ZPA Inspection Profile.
+
+        Args:
+            profile_id (str):
+                The unique id for the ZPA Inspection Profile that will be updated.
+            predef_controls_version (str):
+                The predefined controls version for the ZPA Inspection Profile. Defaults to `OWASP_CRS/3.3.0`.
+            **kwargs:
+                Optional keyword args.
+
+        Keyword Args:
+            **custom_controls (list):
+                A tuple list of custom controls to be added to the Inspection profile.
+
+                Custom control tuples must follow the convention below:
+
+                ``(control_id, action)``
+
+                e.g.
+
+                .. code-block:: python
+
+                    custom_controls = [(99999, "BLOCK"), (88888, "PASS")]
+            **description (str):
+                Additional information about the Inspection Profile.
+            **name (str):
+                The name of the Inspection Profile.
+            **paranoia_level (int):
+                The paranoia level for the Inspection Profile.
+            **predef_controls (list):
+                A tuple list of predefined controls to be added to the Inspection profile.
+
+                Predefined control tuples must follow the convention below:
+
+                ``(control_id, action)``
+
+                e.g.
+
+                .. code-block:: python
+
+                    predef_controls = [(77777, "BLOCK"), (66666, "PASS")]
+            **predef_controls_version (str):
+                The version of the predefined controls that will be added.
+
+        Returns:
+            :obj:`Box`: The updated ZPA Inspection Profile resource record.
+
+        Examples:
+            Update the name and description of a ZPA Inspection Profile with the id 99999:
+
+            .. code-block:: python
+
+                print(
+                    zpa.inspection.update_profile(
+                        "99999",
+                        name="inspect_common_predef_controls",
+                        description="Inspects common controls from the Predefined set.",
+                    )
+                )
+
+            Add a custom control to the ZPA Inspection Profile with the id 88888:
+
+            .. code-block:: python
+
+                print(
+                    zpa.inspection.update_profile(
+                        "88888",
+                        custom_controls=[("2", "BLOCK")],
+                    )
+                )
+
+        """
+        # Set payload to value of existing record
+        payload = self.get_profile(profile_id)
+        payload["predefinedControlsVersion"] = kwargs.get(
+            "predef_controls_version", "OWASP_CRS/3.3.0"
+        )
+
+        # Extend existing list of default predefined controls if the user supplies more
+        if kwargs.get("predef_controls"):
+            controls = kwargs.pop("predef_controls")
+            for control in controls:
+                payload["predefined_controls"] = [
+                    {"id": control[0], "action": control[1]} for control in controls
+                ]
+
+        # Add custom controls if provided
+        if kwargs.get("custom_controls"):
+            controls = kwargs.pop("custom_controls")
+            payload["custom_controls"] = [
+                {"id": control[0], "action": control[1]} for control in controls
+            ]
+
+        # Add optional parameters to payload
+        for key, value in kwargs.items():
+            payload[key] = value
+
+        # Convert from snake case to camel case
+        payload = convert_keys(payload)
+
+        resp = self.rest.put(
+            f"inspectionProfile/{profile_id}", json=payload
+        ).status_code
+
+        # Return the object if it was updated successfully
+        if not isinstance(resp, Response):
+            return self.get_profile(profile_id)
+
+    def update_profile_and_controls(
+        self, profile_id: str, inspection_profile: dict, **kwargs
+    ):
+        """
+        Updates the inspection profile and controls for the specified ID.
+
+        Note:
+            This method has not been fully implemented and will not be maintained. There seems to be functionality
+            duplication with the default Inspection Profile update API call. `**kwargs` has been provided as a parameter
+            for you to be able to add any additional args that Zscaler may add.
+
+            If you feel that this is in error and that this functionality should be correctly implemented by zscaler-sdk-python
+            `raise an issue <https://github.com/zscaler/zscaler-sdk-python/issues>` in the zscaler-sdk-python Github repo
+
+        Args:
+            profile_id (str):
+                The unique id of the inspection profile.
+            inspection_profile (dict):
+                The new inspection profile object.
+            **kwargs:
+                Additional keyword args.
+
+        """
+
+        payload = {
+            "inspection_profile_id": profile_id,
+            "inspection_profile": inspection_profile,
+        }
+
+        payload = convert_keys(payload)
+
+        resp = self.rest.put(
+            "inspectionProfile/{profile_id}/patch", json=payload
+        ).status_code
+
+        # Return the object if it was updated successfully
+        if not isinstance(resp, Response):
+            return self.get_profile(profile_id)