zscaler-sdk-python 1.5.9__tar.gz → 1.7.0__tar.gz

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.5.9
+Version: 1.7.0
 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
+Keywords: zscaler,sdk,zpa,zia,zdx,zcc,ztw,zwa,zidentity
 Author: Zscaler, Inc.
 Author-email: devrel@zscaler.com
 Requires-Python: >=3.9.2,<4.0
@@ -73,6 +73,7 @@ used in your server-side code to interact with the Zscaler API platform across m
 * [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
 * [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
 * [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
+* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
 * [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
 * [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 
@@ -213,6 +214,7 @@ In most cases, you won't need to build the SDK from source. If you want to build
 * [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi)
 * [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
 * [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
+* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
 * [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
 * [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
 * [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
@@ -236,11 +238,14 @@ If your Zscaler tenant has not been migrated to the new Zscaler [Zidentity platf
 
 ## Zscaler OneAPI New Framework
 
-As of the publication of SDK version => 0.20.x, OneAPI is available for programmatic interaction with the following products:
+As of the publication of SDK version => 1.7.x, OneAPI is available for programmatic interaction with the following products:
 
-* [ZIA API](https://help.zscaler.com/oneapi/understanding-oneapi#:~:text=managed%20using%20OneAPI.-,ZIA%20API,-Zscaler%20Internet%20Access)
-* [ZPA API](https://help.zscaler.com/oneapi/understanding-oneapi#:~:text=Workload%20Groups-,ZPA%20API,-Zscaler%20Private%20Access)
-* [Zscaler Client Connector API](https://help.zscaler.com/oneapi/understanding-oneapi#:~:text=Version%20Profiles-,Zscaler%20Client%20Connector%20API,-Zscaler%20Client%20Connector)
+* [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
+* [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
+* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
+* [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
+* [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
+* [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
 
 **NOTE** All other products such as Zscaler Cloud Connector (ZTW) and Zscaler Digital Experience (ZDX) are supported only via the legacy authentication method described in this README.
 
@@ -803,6 +808,162 @@ Each one of the configuration values above can be turned into an environment var
 | `sandboxToken`       | _(String)_ The Zscaler Internet Access Sandbox Token | `ZSCALER_SANDBOX_TOKEN` |
 | `sandboxCloud`       | _(String)_ The Zscaler Internet Access Sandbox cloud name | `ZSCALER_SANDBOX_CLOUD` |
 
+### Zscaler ZIdentity API
+
+This SDK supports programmatic integration with the Zscaler ZIdentity API service.
+
+The authentication to Zscaler ZIdentity service via the OneAPI framework, requires uses the API client `ZscalerClient`
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `clientId`       | _(String)_ Zscaler API Client ID, used with `clientSecret` or `PrivateKey` OAuth auth mode.| `ZSCALER_CLIENT_ID` |
+| `clientSecret`       | _(String)_ A string that contains the password for the API admin.| `ZSCALER_CLIENT_SECRET` |
+| `privateKey`       | _(String)_ A string Private key value.| `ZSCALER_PRIVATE_KEY` |
+| `vanityDomain`       | _(String)_ Refers to the domain name used by your organization `https://<vanity_domain>.zslogin.net/oauth2/v1/token` | `ZSCALER_VANITY_DOMAIN` |
+| `cloud`
+
+### Initialize OneAPI OAuth 2.0 Client
+
+#### Zidentity OneAPI Client ID and Client Secret Authentication
+
+Construct a client instance by passing your Zidentity `clientId`, `clientSecret` and `vanityDomain`:
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta", # Optional when authenticating to an alternative cloud environment
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        users, _, error = client.zidentity.groups.list_groups()
+        if error:
+            print(f"Error listing users: {error}")
+            return
+
+        print(f"Total users found: {len(users)}")
+
+if __name__ == "__main__":
+    main()
+```
+
+#### Zidentity OneAPI Client ID and Private Key Authentication
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "privateKey": '{yourPrivateKey}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta", # Optional when authenticating to an alternative cloud environment
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        users, _, error = client.zidentity.groups.list_groups()
+        if error:
+            print(f"Error listing users: {error}")
+            return
+
+        print(f"Total users found: {len(users)}")
+
+if __name__ == "__main__":
+    main()
+```
+
+### Zscaler Sandbox Authentication
+
+To authenticate to the Zscaler Sandbox service you must authenticate by instantiating the `ZscalerClient`.
+
+Authentication to Zscaler Sandbox requires the attribute/parameter `sandboxCloud`. The following cloud environments are supported:
+
+* `zscaler`
+* `zscalerone`
+* `zscalertwo`
+* `zscalerthree`
+* `zscloud`
+* `zscalerbeta`
+* `zscalergov`
+* `zscalerten`
+* `zspreview`
+
+### Environment variables
+
+You can provide credentials via the `ZSCALER_SANDBOX_TOKEN`, `ZSCALER_SANDBOX_CLOUD` environment variables, representing your Zscaler Sandbox authentication paraemters respectively `sandboxToken`, `sandboxCloud`
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `sandboxToken`       | _(String)_ The Zscaler Internet Access Sandbox Token | `ZSCALER_SANDBOX_TOKEN` |
+| `sandboxCloud`       | _(String)_ The Zscaler Internet Access Sandbox cloud name | `ZSCALER_SANDBOX_CLOUD` |
+
+### Zscaler Sandbox Client Initialization
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "sandboxToken": '{yourSandboxToken}',
+    "sandboxCloud": '{yourSandboxCloud}',
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    file_path = os.path.join(script_dir, "test-pe-file.exe")
+    force_analysis = True
+
+    with ZscalerClient(config) as client:
+        submit, _, err = client.zia.sandbox.submit_file(file_path=file_path, force=force_analysis)
+
+        if err:
+            print(f"Error submitting file: {err}")
+        else:
+            print("File submitted successfully!")
+            print(f"Response: {submit}")
+
+if __name__ == "__main__":
+    main()
+```
+
+### ZIA Legacy Client Initialization
+
+```py
+import random
+from zscaler import ZscalerClient
+
+config = {
+    "sandboxToken": '{yourSandboxToken}',
+    "sandboxCloud": '{yourSandboxCloud}',
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    file_path = os.path.join(script_dir, "test-pe-file.exe")
+    force_analysis = True
+
+    with ZscalerClient(config) as client:
+        submit, _, err = client.zia.sandbox.submit_file(file_path=file_path, force=force_analysis)
+
+        if err:
+            print(f"Error submitting file: {err}")
+        else:
+            print("File submitted successfully!")
+            print(f"Response: {submit}")
+
+if __name__ == "__main__":
+    main()
+```
+
 ## 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.
@@ -1077,7 +1238,7 @@ The ZCC Cloud is identified by several cloud name prefixes, which determines whi
 
 ### Environment variables
 
-You can provide credentials via the `ZCC_CLIENT_ID`, `ZCC_CLIENT_ID`, `ZCC_CLOUD` environment variables, representing your ZIA `api_key`, `secret_key`, and `cloud` respectively.
+You can provide credentials via the `ZCC_CLIENT_ID`, `ZCC_CLIENT_SECRET`, `ZCC_CLOUD` environment variables, representing your ZIA `api_key`, `secret_key`, and `cloud` respectively.
 
 ~> **NOTE** `ZCC_CLOUD` environment variable is required, and is used to identify the correct API gateway where the API requests should be forwarded to.
 

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/README.md

@@ -34,6 +34,7 @@ used in your server-side code to interact with the Zscaler API platform across m
 * [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
 * [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
 * [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
+* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
 * [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
 * [ZWA API](https://help.zscaler.com/workflow-automation/getting-started-workflow-automation-api)
 
@@ -174,6 +175,7 @@ In most cases, you won't need to build the SDK from source. If you want to build
 * [OneAPI](https://help.zscaler.com/oneapi/understanding-oneapi)
 * [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
 * [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
+* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
 * [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
 * [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
 * [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
@@ -197,11 +199,14 @@ If your Zscaler tenant has not been migrated to the new Zscaler [Zidentity platf
 
 ## Zscaler OneAPI New Framework
 
-As of the publication of SDK version => 0.20.x, OneAPI is available for programmatic interaction with the following products:
+As of the publication of SDK version => 1.7.x, OneAPI is available for programmatic interaction with the following products:
 
-* [ZIA API](https://help.zscaler.com/oneapi/understanding-oneapi#:~:text=managed%20using%20OneAPI.-,ZIA%20API,-Zscaler%20Internet%20Access)
-* [ZPA API](https://help.zscaler.com/oneapi/understanding-oneapi#:~:text=Workload%20Groups-,ZPA%20API,-Zscaler%20Private%20Access)
-* [Zscaler Client Connector API](https://help.zscaler.com/oneapi/understanding-oneapi#:~:text=Version%20Profiles-,Zscaler%20Client%20Connector%20API,-Zscaler%20Client%20Connector)
+* [ZPA API](https://help.zscaler.com/zpa/zpa-api/api-developer-reference-guide)
+* [ZIA API](https://help.zscaler.com/zia/getting-started-zia-api)
+* [ZIdentity](https://help.zscaler.com/zidentity/getting-started-zidentity-api)
+* [ZDX API](https://help.zscaler.com/zdx/understanding-zdx-api)
+* [ZCC API](https://help.zscaler.com/client-connector/getting-started-client-connector-api)
+* [ZTW API](https://help.zscaler.com/cloud-branch-connector/getting-started-cloud-branch-connector-api)
 
 **NOTE** All other products such as Zscaler Cloud Connector (ZTW) and Zscaler Digital Experience (ZDX) are supported only via the legacy authentication method described in this README.
 
@@ -764,6 +769,162 @@ Each one of the configuration values above can be turned into an environment var
 | `sandboxToken`       | _(String)_ The Zscaler Internet Access Sandbox Token | `ZSCALER_SANDBOX_TOKEN` |
 | `sandboxCloud`       | _(String)_ The Zscaler Internet Access Sandbox cloud name | `ZSCALER_SANDBOX_CLOUD` |
 
+### Zscaler ZIdentity API
+
+This SDK supports programmatic integration with the Zscaler ZIdentity API service.
+
+The authentication to Zscaler ZIdentity service via the OneAPI framework, requires uses the API client `ZscalerClient`
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `clientId`       | _(String)_ Zscaler API Client ID, used with `clientSecret` or `PrivateKey` OAuth auth mode.| `ZSCALER_CLIENT_ID` |
+| `clientSecret`       | _(String)_ A string that contains the password for the API admin.| `ZSCALER_CLIENT_SECRET` |
+| `privateKey`       | _(String)_ A string Private key value.| `ZSCALER_PRIVATE_KEY` |
+| `vanityDomain`       | _(String)_ Refers to the domain name used by your organization `https://<vanity_domain>.zslogin.net/oauth2/v1/token` | `ZSCALER_VANITY_DOMAIN` |
+| `cloud`
+
+### Initialize OneAPI OAuth 2.0 Client
+
+#### Zidentity OneAPI Client ID and Client Secret Authentication
+
+Construct a client instance by passing your Zidentity `clientId`, `clientSecret` and `vanityDomain`:
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta", # Optional when authenticating to an alternative cloud environment
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        users, _, error = client.zidentity.groups.list_groups()
+        if error:
+            print(f"Error listing users: {error}")
+            return
+
+        print(f"Total users found: {len(users)}")
+
+if __name__ == "__main__":
+    main()
+```
+
+#### Zidentity OneAPI Client ID and Private Key Authentication
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "privateKey": '{yourPrivateKey}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta", # Optional when authenticating to an alternative cloud environment
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        users, _, error = client.zidentity.groups.list_groups()
+        if error:
+            print(f"Error listing users: {error}")
+            return
+
+        print(f"Total users found: {len(users)}")
+
+if __name__ == "__main__":
+    main()
+```
+
+### Zscaler Sandbox Authentication
+
+To authenticate to the Zscaler Sandbox service you must authenticate by instantiating the `ZscalerClient`.
+
+Authentication to Zscaler Sandbox requires the attribute/parameter `sandboxCloud`. The following cloud environments are supported:
+
+* `zscaler`
+* `zscalerone`
+* `zscalertwo`
+* `zscalerthree`
+* `zscloud`
+* `zscalerbeta`
+* `zscalergov`
+* `zscalerten`
+* `zspreview`
+
+### Environment variables
+
+You can provide credentials via the `ZSCALER_SANDBOX_TOKEN`, `ZSCALER_SANDBOX_CLOUD` environment variables, representing your Zscaler Sandbox authentication paraemters respectively `sandboxToken`, `sandboxCloud`
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `sandboxToken`       | _(String)_ The Zscaler Internet Access Sandbox Token | `ZSCALER_SANDBOX_TOKEN` |
+| `sandboxCloud`       | _(String)_ The Zscaler Internet Access Sandbox cloud name | `ZSCALER_SANDBOX_CLOUD` |
+
+### Zscaler Sandbox Client Initialization
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "sandboxToken": '{yourSandboxToken}',
+    "sandboxCloud": '{yourSandboxCloud}',
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    file_path = os.path.join(script_dir, "test-pe-file.exe")
+    force_analysis = True
+
+    with ZscalerClient(config) as client:
+        submit, _, err = client.zia.sandbox.submit_file(file_path=file_path, force=force_analysis)
+
+        if err:
+            print(f"Error submitting file: {err}")
+        else:
+            print("File submitted successfully!")
+            print(f"Response: {submit}")
+
+if __name__ == "__main__":
+    main()
+```
+
+### ZIA Legacy Client Initialization
+
+```py
+import random
+from zscaler import ZscalerClient
+
+config = {
+    "sandboxToken": '{yourSandboxToken}',
+    "sandboxCloud": '{yourSandboxCloud}',
+    "logging": {"enabled": False, "verbose": False},
+}
+
+def main():
+
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    file_path = os.path.join(script_dir, "test-pe-file.exe")
+    force_analysis = True
+
+    with ZscalerClient(config) as client:
+        submit, _, err = client.zia.sandbox.submit_file(file_path=file_path, force=force_analysis)
+
+        if err:
+            print(f"Error submitting file: {err}")
+        else:
+            print("File submitted successfully!")
+            print(f"Response: {submit}")
+
+if __name__ == "__main__":
+    main()
+```
+
 ## 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.
@@ -1038,7 +1199,7 @@ The ZCC Cloud is identified by several cloud name prefixes, which determines whi
 
 ### Environment variables
 
-You can provide credentials via the `ZCC_CLIENT_ID`, `ZCC_CLIENT_ID`, `ZCC_CLOUD` environment variables, representing your ZIA `api_key`, `secret_key`, and `cloud` respectively.
+You can provide credentials via the `ZCC_CLIENT_ID`, `ZCC_CLIENT_SECRET`, `ZCC_CLOUD` environment variables, representing your ZIA `api_key`, `secret_key`, and `cloud` respectively.
 
 ~> **NOTE** `ZCC_CLOUD` environment variable is required, and is used to identify the correct API gateway where the API requests should be forwarded to.
 

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.5.9"
+version = "1.7.0"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -8,7 +8,7 @@ readme = "README.md"
 homepage = "https://github.com/zscaler/zscaler-sdk-python"
 repository = "https://github.com/zscaler/zscaler-sdk-python"
 documentation = "https://zscaler-sdk-python.readthedocs.io"
-keywords = ["zscaler", "sdk", "zpa", "zia", "zdx", "zcc", "ztw", "zwa"]
+keywords = ["zscaler", "sdk", "zpa", "zia", "zdx", "zcc", "ztw", "zwa", "zidentity"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/__init__.py

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

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/errors/response_checker.py

@@ -7,7 +7,7 @@ from zscaler.exceptions import exceptions
 
 logger = logging.getLogger(__name__)
 
-@staticmethod
+# @staticmethod
 def check_response_for_error(url, response_details, response_body):
     """
     Checks HTTP response for errors in the response body.

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/helpers.py

@@ -124,7 +124,11 @@ def to_snake_case(string):
         "extranetDTO": "extranet_dto",
         "locationGroupDTO": "location_group_dto",
         "locationDTO": "location_dto",
-        "predefinedADPControls": "predefined_adp_controls"
+        "predefinedADPControls": "predefined_adp_controls",
+        "runtimeOS": "runtime_os",
+        
+        # ZIdentity Edge Cases
+        # "clientJWKsUrl": "clientJWKsUrl",
     }
 
     if string in FIELD_EXCEPTIONS:
@@ -256,7 +260,8 @@ def to_lower_camel_case(string):
         "extranet_dto": "extranetDTO",
         "location_group_dto": "locationGroupDTO",
         "location_dto": "locationDTO",
-        "predefined_adp_controls": "predefinedADPControls"
+        "predefined_adp_controls": "predefinedADPControls",
+        "runtime_os": "runtimeOS"
     }
 
     if string in FIELD_EXCEPTIONS:

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/oneapi_client.py

@@ -15,6 +15,7 @@ from zscaler.zdx.zdx_service import ZDXService
 from zscaler.zia.zia_service import ZIAService
 from zscaler.zpa.zpa_service import ZPAService
 from zscaler.zwa.zwa_service import ZWAService
+from zscaler.zidentity.zidentity_service import ZIdentityService
 from zscaler.zcc.legacy import LegacyZCCClientHelper
 from zscaler.ztw.legacy import LegacyZTWClientHelper
 from zscaler.zdx.legacy import LegacyZDXClientHelper
@@ -187,6 +188,7 @@ class Client:
         self._zwa = None
         self._zpa = None
         self._zdx = None
+        self._zidentity = None
         # self.logger.debug("Client initialized successfully.")
 
     def authenticate(self):
@@ -252,6 +254,12 @@ class Client:
             self._zpa = ZPAService(self._request_executor, self._config)
         return self._zpa
 
+    @property
+    def zidentity(self):
+        if self._zidentity is None:
+            self._zidentity = ZIdentityService(self._request_executor)
+        return self._zidentity
+    
     def __enter__(self):
         """
         Automatically create and set session within context manager.

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/oneapi_http_client.py

@@ -104,11 +104,11 @@ class HTTPClient:
             }
 
             # Handle payload
-            if request.get("json"):
+            if "json" in request:
                 params["json"] = request["json"]
-            elif request.get("data"):
+            elif "data" in request:
                 params["data"] = request["data"]
-            elif request.get("form"):
+            elif "form" in request:
                 params["data"] = request["form"]
             if request["params"]:
                 params["params"] = request["params"]

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/request_executor.py

@@ -83,6 +83,7 @@ class RequestExecutor:
         self.service = self._config["client"].get("service", "zia")  # Default to ZIA
         self.customer_id = self._config["client"].get("customerId")  # Optional for ZIA/ZCC
         self.microtenant_id = self._config["client"].get("microtenantId")  # Optional for ZIA/ZCC
+        self.vanity_domain = self._config["client"].get("vanityDomain")  # Required for zidentity service
 
         # OAuth2 setup
         self._oauth = OAuth(self, self._config)
@@ -127,6 +128,18 @@ class RequestExecutor:
         # logger.debug(f"Determining base URL for cloud: {self.cloud}")
         if "/zscsb" in endpoint:
             return f"https://csbapi.{self.sandbox_cloud}.net"
+        
+        # Special handling for zidentity service
+        if "/zidentity" in endpoint or "/admin/api/v1" in endpoint:
+            if not self.vanity_domain:
+                raise ValueError("vanityDomain is required for zidentity service")
+            
+            # For zidentity, the URL pattern is: https://{{vanity_domain}}-admin.zslogin{{cloud}}.net/admin/api/v1
+            if self.cloud and self.cloud != "production":
+                return f"https://{self.vanity_domain}-admin.zslogin{self.cloud}.net/admin/api/v1"
+            else:
+                return f"https://{self.vanity_domain}-admin.zslogin.net/admin/api/v1"
+        
         if self.cloud and self.cloud != "production":
             return f"https://api.{self.cloud}.zsapi.net"
         return self.BASE_URL
@@ -147,7 +160,10 @@ class RequestExecutor:
             return "zwa"
         elif "/zpa" in url or "/mgmtconfig" in url:
             return "zpa"
-
+        elif "/admin/api/v1" in url:
+            return "zidentity"
+        elif "/admin" in url:
+            return "admin"
         if self.use_legacy_client:
             url = self.remove_oneapi_endpoint_prefix(url)
             # Recheck for service type after removing the prefix
@@ -163,11 +179,13 @@ class RequestExecutor:
                 return "zwa"
             elif "/zpa" in url or "/mgmtconfig" in url:
                 return "zpa"
+            elif "/admin/api/v1" in url:
+                return "zidentity"
 
         raise ValueError(f"Unsupported service: {url}")
 
     def remove_oneapi_endpoint_prefix(self, endpoint: str) -> str:
-        prefixes = ["/zia", "/zpa", "/zcc", "/ztw", "/zdx", "/zwa"]
+        prefixes = ["admin", "/zia", "/zpa", "/zcc", "/ztw", "/zdx", "/zwa"]
         for prefix in prefixes:
             if endpoint.startswith(prefix):
                 return endpoint[len(prefix) :]
@@ -188,7 +206,9 @@ class RequestExecutor:
             logger.error(f"Service detection failed: {e}")
             raise
 
-        body = body or {}
+        # Preserve empty lists, only convert None to empty dict
+        if body is None:
+            body = {}
         headers = headers or {}
         params = params or {}
 
@@ -212,6 +232,11 @@ class RequestExecutor:
         else:
             base_url = self.get_base_url(endpoint)
 
+        # Special handling for zidentity to avoid endpoint duplication
+        if service_type == "zidentity" and endpoint.startswith("/admin/api/v1/"):
+            # Remove the /admin/api/v1 prefix since it's already in the base URL
+            endpoint = endpoint[len("/admin/api/v1/"):]
+
         final_url = f"{base_url}/{endpoint.lstrip('/')}"
 
         headers = self._prepare_headers(headers, endpoint)

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/utils.py

@@ -236,17 +236,39 @@ def transform_common_id_fields(id_groups: list, source_dict: dict, target_dict:
                 final_list = []
                 for item in value:
                     if isinstance(item, (str, int)):
-                        final_list.append({"id": int(item)})
+                        # 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)})
                     elif isinstance(item, dict) and "id" in item:
                         # Possibly user gave { "id": 123, ... }
-                        item["id"] = int(item["id"])
+                        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"])
                         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
-                value["id"] = int(value["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"])
                 target_dict[payload_key] = value
     return
 

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/zcc/devices.py

@@ -407,6 +407,8 @@ class DevicesAPI(APIClient):
         """
         )
 
+        query_params = query_params or {}
+
         body = {}
         headers = {}
 

{zscaler_sdk_python-1.5.9 → zscaler_sdk_python-1.7.0}/zscaler/zdx/admin.py

@@ -46,7 +46,7 @@ class AdminAPI(APIClient):
         Examples:
             Prints all configured departments.
 
-            >>> dept_list, _, err = client.zdx.admin.list_departments(ss)
+            >>> dept_list, _, err = client.zdx.admin.list_departments()
             ... if err:
             ...     print(f"Error listing department: {err}")
             ...     return