zscaler-sdk-python 1.9.38__tar.gz → 1.9.39__tar.gz

zscaler_sdk_python-1.9.38/README.md → zscaler_sdk_python-1.9.39/PKG-INFO

@@ -1,3 +1,42 @@
+Metadata-Version: 2.1
+Name: zscaler-sdk-python
+Version: 1.9.39
+Summary: Official Python SDK for the Zscaler Products
+Home-page: https://github.com/zscaler/zscaler-sdk-python
+License: MIT
+Keywords: zscaler,sdk,zpa,zia,zdx,zcc,ztw,zwa,zid,zidentity
+Author: Zscaler, Inc.
+Author-email: devrel@zscaler.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: dev
+Requires-Dist: PyJWT (>=2.10.1)
+Requires-Dist: aenum (>=3.1.11)
+Requires-Dist: arrow (>=1.3.0)
+Requires-Dist: cryptography (>=45.0.2)
+Requires-Dist: jmespath (>=1.0.0)
+Requires-Dist: jwcrypto (>=1.5.6)
+Requires-Dist: pydash (>=8.0.3)
+Requires-Dist: python-box (>=7.3.0)
+Requires-Dist: python-dateutil (>=2.9.0)
+Requires-Dist: pytz (>=2024.2)
+Requires-Dist: pyyaml (>=6.0.0)
+Requires-Dist: requests (>=2.32.3)
+Requires-Dist: urllib3 (>=2.6.0)
+Project-URL: Bug Tracker, https://github.com/zscaler/zscaler-sdk-python/issues
+Project-URL: Documentation, https://zscaler-sdk-python.readthedocs.io
+Project-URL: Repository, https://github.com/zscaler/zscaler-sdk-python
+Description-Content-Type: text/markdown
+
 # Official Python SDK for the Zscaler Products
 
 [![PyPI - Downloads](https://img.shields.io/pypi/dw/zscaler-sdk-python)](https://pypistats.org/packages/zscaler-sdk-python)
@@ -1404,6 +1443,83 @@ if __name__ == "__main__":
 
 **Note:** `client.zmicroseg` is available as an alias for `client.zms`.
 
+### Zscaler AI Guard (aiguard)
+
+AI Guard provides configuration and detection APIs to secure the use of generative AI — detection policies, policy match rules, LLM providers, LLM applications, and their credentials.
+
+AI Guard is split across **two** authentication paths:
+
+| Resource | Client | Endpoint |
+|---|---|---|
+| Detection policies, policy match rules, LLM providers/applications and their credentials | `ZscalerClient` (OneAPI) | `/aiguard/v1/*` |
+| `policy_detection` — `execute_policy`, `resolve_and_execute_policy` | `LegacyAIGuardClient` | `/v1/detection/*` |
+
+**Important:** the policy detection endpoints are **not** exposed through OneAPI. They must be
+called with `LegacyAIGuardClient`, which authenticates with an AI Guard API key against
+`https://api.<cloud>.zseclipse.net`. Every other AI Guard resource is OneAPI only.
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta",
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        policies, _, err = client.aiguard.policies.list_policies()
+        if err:
+            print(f"Error: {err}")
+            return
+        for policy in policies:
+            print(policy.as_dict())
+
+if __name__ == "__main__":
+    main()
+```
+
+**Available Resources (via `client.aiguard.<resource>`):**
+
+- `policies` — List, get (by ID or name), create, update, and delete detection policies
+- `policy_match_rules` — List, get (by ID or name), create, update, and delete policy match rules
+- `llm_providers` — Manage LLM providers, list provider types, and run referential checks
+- `llm_provider_credentials` — Manage LLM provider credentials and run referential checks
+- `llm_applications` — Manage LLM applications and run referential checks
+- `llm_application_credentials` — Manage LLM application credentials
+
+**Policy detection (legacy client only):**
+
+```py
+from zscaler.oneapi_client import LegacyAIGuardClient
+
+config = {
+    "api_key": '{yourAIGuardApiKey}',   # or the AIGUARD_API_KEY environment variable
+    "cloud": "us1",                     # or AIGUARD_CLOUD
+}
+
+def main():
+    with LegacyAIGuardClient(config) as client:
+        result, _, err = client.aiguard.policy_detection.resolve_and_execute_policy(
+            content="User prompt or AI response to scan",
+            direction="IN",
+        )
+        if err:
+            print(f"Error: {err}")
+            return
+        print(result.as_dict())
+
+if __name__ == "__main__":
+    main()
+```
+
+- `policy_detection` — Execute a detection policy (`execute_policy`) or resolve-and-execute
+  (`resolve_and_execute_policy`) against content. **Requires `LegacyAIGuardClient`.**
+
+**Note:** `client.zguard` is available as a deprecated alias for `client.aiguard`.
+
 ## Zscaler Legacy API Framework
 
 The legacy Zscaler API is still utilized by several customers, and will remain in place for the foreseeable future with no specific announced deprecation date.
@@ -1970,3 +2086,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+

zscaler_sdk_python-1.9.38/PKG-INFO → zscaler_sdk_python-1.9.39/README.md

@@ -1,45 +1,3 @@
-Metadata-Version: 2.4
-Name: zscaler-sdk-python
-Version: 1.9.38
-Summary: Official Python SDK for the Zscaler Products
-License: MIT
-License-File: LICENSE.md
-Keywords: zscaler,sdk,zpa,zia,zdx,zcc,ztw,zwa,zid,zidentity
-Author: Zscaler, Inc.
-Author-email: devrel@zscaler.com
-Requires-Python: >=3.10,<4.0
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Security
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Provides-Extra: dev
-Requires-Dist: PyJWT (>=2.10.1)
-Requires-Dist: aenum (>=3.1.11)
-Requires-Dist: arrow (>=1.3.0)
-Requires-Dist: cryptography (>=45.0.2)
-Requires-Dist: jmespath (>=1.0.0)
-Requires-Dist: jwcrypto (>=1.5.6)
-Requires-Dist: pydash (>=8.0.3)
-Requires-Dist: python-box (>=7.3.0)
-Requires-Dist: python-dateutil (>=2.9.0)
-Requires-Dist: pytz (>=2024.2)
-Requires-Dist: pyyaml (>=6.0.0)
-Requires-Dist: requests (>=2.32.3)
-Requires-Dist: urllib3 (>=2.6.0)
-Project-URL: Bug Tracker, https://github.com/zscaler/zscaler-sdk-python/issues
-Project-URL: Documentation, https://zscaler-sdk-python.readthedocs.io
-Project-URL: Homepage, https://github.com/zscaler/zscaler-sdk-python
-Project-URL: Repository, https://github.com/zscaler/zscaler-sdk-python
-Description-Content-Type: text/markdown
-
 # Official Python SDK for the Zscaler Products
 
 [![PyPI - Downloads](https://img.shields.io/pypi/dw/zscaler-sdk-python)](https://pypistats.org/packages/zscaler-sdk-python)
@@ -1446,6 +1404,83 @@ if __name__ == "__main__":
 
 **Note:** `client.zmicroseg` is available as an alias for `client.zms`.
 
+### Zscaler AI Guard (aiguard)
+
+AI Guard provides configuration and detection APIs to secure the use of generative AI — detection policies, policy match rules, LLM providers, LLM applications, and their credentials.
+
+AI Guard is split across **two** authentication paths:
+
+| Resource | Client | Endpoint |
+|---|---|---|
+| Detection policies, policy match rules, LLM providers/applications and their credentials | `ZscalerClient` (OneAPI) | `/aiguard/v1/*` |
+| `policy_detection` — `execute_policy`, `resolve_and_execute_policy` | `LegacyAIGuardClient` | `/v1/detection/*` |
+
+**Important:** the policy detection endpoints are **not** exposed through OneAPI. They must be
+called with `LegacyAIGuardClient`, which authenticates with an AI Guard API key against
+`https://api.<cloud>.zseclipse.net`. Every other AI Guard resource is OneAPI only.
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta",
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        policies, _, err = client.aiguard.policies.list_policies()
+        if err:
+            print(f"Error: {err}")
+            return
+        for policy in policies:
+            print(policy.as_dict())
+
+if __name__ == "__main__":
+    main()
+```
+
+**Available Resources (via `client.aiguard.<resource>`):**
+
+- `policies` — List, get (by ID or name), create, update, and delete detection policies
+- `policy_match_rules` — List, get (by ID or name), create, update, and delete policy match rules
+- `llm_providers` — Manage LLM providers, list provider types, and run referential checks
+- `llm_provider_credentials` — Manage LLM provider credentials and run referential checks
+- `llm_applications` — Manage LLM applications and run referential checks
+- `llm_application_credentials` — Manage LLM application credentials
+
+**Policy detection (legacy client only):**
+
+```py
+from zscaler.oneapi_client import LegacyAIGuardClient
+
+config = {
+    "api_key": '{yourAIGuardApiKey}',   # or the AIGUARD_API_KEY environment variable
+    "cloud": "us1",                     # or AIGUARD_CLOUD
+}
+
+def main():
+    with LegacyAIGuardClient(config) as client:
+        result, _, err = client.aiguard.policy_detection.resolve_and_execute_policy(
+            content="User prompt or AI response to scan",
+            direction="IN",
+        )
+        if err:
+            print(f"Error: {err}")
+            return
+        print(result.as_dict())
+
+if __name__ == "__main__":
+    main()
+```
+
+- `policy_detection` — Execute a detection policy (`execute_policy`) or resolve-and-execute
+  (`resolve_and_execute_policy`) against content. **Requires `LegacyAIGuardClient`.**
+
+**Note:** `client.zguard` is available as a deprecated alias for `client.aiguard`.
+
 ## Zscaler Legacy API Framework
 
 The legacy Zscaler API is still utilized by several customers, and will remain in place for the foreseeable future with no specific announced deprecation date.
@@ -2012,4 +2047,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

{zscaler_sdk_python-1.9.38 → zscaler_sdk_python-1.9.39}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.9.38"
+version = "1.9.39"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -45,7 +45,7 @@ jmespath = ">=1.0.0"
 [tool.poetry.group.dev.dependencies]
 black = ">=24.3.0"
 python-dotenv = ">=1.0.0"
-ruff = ">=0.15.0"
+ruff = ">=0.15.0,<0.16"
 pytest = ">=8.3.5"
 pytest-mock = ">=3.12.0"
 pytest-asyncio = ">=0.23.0"

{zscaler_sdk_python-1.9.38 → zscaler_sdk_python-1.9.39}/zscaler/__init__.py

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

zscaler_sdk_python-1.9.39/zscaler/aiguard/aiguard_service.py

@@ -0,0 +1,84 @@
+"""
+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 zscaler.aiguard.llm_application_credentials import LLMApplicationCredentialsAPI
+from zscaler.aiguard.llm_applications import LLMApplicationsAPI
+from zscaler.aiguard.llm_provider_credentials import LLMProviderCredentialsAPI
+from zscaler.aiguard.llm_providers import LLMProvidersAPI
+from zscaler.aiguard.policies import PoliciesAPI
+from zscaler.aiguard.policy_match_rules import PolicyMatchRulesAPI
+from zscaler.request_executor import RequestExecutor
+
+
+class AIGuardService:
+    """
+    AI Guard Service client, exposing the AI Guard configuration APIs over OneAPI.
+
+    Policy detection (``/v1/detection/*``) is **not** available through OneAPI and is
+    therefore not exposed here -- use ``LegacyAIGuardClient(...).aiguard.policy_detection``.
+    """
+
+    def __init__(self, request_executor: RequestExecutor) -> None:
+        self._request_executor = request_executor
+
+    @property
+    def policies(self) -> PoliciesAPI:
+        """
+        The interface object for the :ref:`AI Guard Detection Policies interface <aiguard-policies>`.
+
+        """
+        return PoliciesAPI(self._request_executor)
+
+    @property
+    def policy_match_rules(self) -> PolicyMatchRulesAPI:
+        """
+        The interface object for the :ref:`AI Guard Policy Match Rules interface <aiguard-policy_match_rules>`.
+
+        """
+        return PolicyMatchRulesAPI(self._request_executor)
+
+    @property
+    def llm_providers(self) -> LLMProvidersAPI:
+        """
+        The interface object for the :ref:`AI Guard LLM Providers interface <aiguard-llm_providers>`.
+
+        """
+        return LLMProvidersAPI(self._request_executor)
+
+    @property
+    def llm_provider_credentials(self) -> LLMProviderCredentialsAPI:
+        """
+        The interface object for the :ref:`AI Guard LLM Provider Credentials interface <aiguard-llm_provider_credentials>`.
+
+        """
+        return LLMProviderCredentialsAPI(self._request_executor)
+
+    @property
+    def llm_applications(self) -> LLMApplicationsAPI:
+        """
+        The interface object for the :ref:`AI Guard LLM Applications interface <aiguard-llm_applications>`.
+
+        """
+        return LLMApplicationsAPI(self._request_executor)
+
+    @property
+    def llm_application_credentials(self) -> LLMApplicationCredentialsAPI:
+        """
+        The interface object for the
+        :ref:`AI Guard LLM Application Credentials interface <aiguard-llm_application_credentials>`.
+
+        """
+        return LLMApplicationCredentialsAPI(self._request_executor)

{zscaler_sdk_python-1.9.38/zscaler/zaiguard → zscaler_sdk_python-1.9.39/zscaler/aiguard}/legacy.py

@@ -35,7 +35,7 @@ logger = logging.getLogger("zscaler-sdk-python")
 
 # Import all AIGuard API classes for type hints only (to avoid circular imports)
 if TYPE_CHECKING:
-    from zscaler.zaiguard.policy_detection import PolicyDetectionAPI
+    from zscaler.aiguard.policy_detection import PolicyDetectionAPI
 
 
 class LegacyZGuardClientHelper:
@@ -146,7 +146,7 @@ class LegacyZGuardClientHelper:
                 config=config,
                 cache=self.cache,
                 http_client=None,
-                zguard_legacy_client=self,
+                aiguard_legacy_client=self,
             )
 
         self._session = None
@@ -159,7 +159,7 @@ class LegacyZGuardClientHelper:
         Returns:
             PolicyDetectionAPI: Interface for policy detection operations
         """
-        from zscaler.zaiguard.policy_detection import PolicyDetectionAPI
+        from zscaler.aiguard.policy_detection import PolicyDetectionAPI
 
         return PolicyDetectionAPI(self.request_executor)