zscaler-sdk-python 1.6.0__tar.gz → 1.7.1__tar.gz

{zscaler_sdk_python-1.6.0 → zscaler_sdk_python-1.7.1}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.6.0
+Version: 1.7.1
 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,225 @@ 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`
+
+#### Zidentity Pagination
+
+Zidentity API supports pagination with a maximum page size of 100 records per request. The SDK automatically handles pagination for Zidentity endpoints.
+
+**Key Features:**
+- **Maximum Page Size**: 100 records per page (enforced by API)
+- **Automatic Pagination**: SDK handles pagination transparently
+- **Response Format**: Returns data in `records` field with pagination metadata
+
+**Example Usage:**
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta",
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        # Request 300 groups (will automatically fetch 3 pages)
+        groups_response, response, error = client.zidentity.groups.list_groups(
+            query_params={'page_size': 300}
+        )
+        
+        if error:
+            print(f"Error listing groups: {error}")
+            return
+        
+        print(f"Total groups in response: {len(groups_response.records)}")
+        print(f"Total available: {groups_response.results_total}")
+        print(f"Page offset: {groups_response.page_offset}")
+        print(f"Page size: {groups_response.page_size}")
+        
+        # Access individual groups
+        for group in groups_response.records:
+            print(f"Group: {group.name} (ID: {group.id})")
+        
+        # Manual pagination using response object
+        while response.has_next():
+            next_results, error = response.next()
+            if error:
+                print(f"Error fetching next page: {error}")
+                break
+            
+            print(f"Next page: {len(next_results)} groups")
+            for group in next_results:
+                print(f"Group: {group['name']} (ID: {group['id']})")
+
+if __name__ == "__main__":
+    main()
+```
+
+**Pagination Metadata:**
+- `results_total`: Total number of records available
+- `page_offset`: Current page offset
+- `page_size`: Number of records per page (max 100)
+- `next_link`: URL for next page (if available)
+- `prev_link`: URL for previous page (if available)
+
+| 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.

{zscaler_sdk_python-1.6.0 → zscaler_sdk_python-1.7.1}/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,225 @@ 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`
+
+#### Zidentity Pagination
+
+Zidentity API supports pagination with a maximum page size of 100 records per request. The SDK automatically handles pagination for Zidentity endpoints.
+
+**Key Features:**
+- **Maximum Page Size**: 100 records per page (enforced by API)
+- **Automatic Pagination**: SDK handles pagination transparently
+- **Response Format**: Returns data in `records` field with pagination metadata
+
+**Example Usage:**
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "beta",
+}
+
+def main():
+    with ZscalerClient(config) as client:
+        # Request 300 groups (will automatically fetch 3 pages)
+        groups_response, response, error = client.zidentity.groups.list_groups(
+            query_params={'page_size': 300}
+        )
+        
+        if error:
+            print(f"Error listing groups: {error}")
+            return
+        
+        print(f"Total groups in response: {len(groups_response.records)}")
+        print(f"Total available: {groups_response.results_total}")
+        print(f"Page offset: {groups_response.page_offset}")
+        print(f"Page size: {groups_response.page_size}")
+        
+        # Access individual groups
+        for group in groups_response.records:
+            print(f"Group: {group.name} (ID: {group.id})")
+        
+        # Manual pagination using response object
+        while response.has_next():
+            next_results, error = response.next()
+            if error:
+                print(f"Error fetching next page: {error}")
+                break
+            
+            print(f"Next page: {len(next_results)} groups")
+            for group in next_results:
+                print(f"Group: {group['name']} (ID: {group['id']})")
+
+if __name__ == "__main__":
+    main()
+```
+
+**Pagination Metadata:**
+- `results_total`: Total number of records available
+- `page_offset`: Current page offset
+- `page_size`: Number of records per page (max 100)
+- `next_link`: URL for next page (if available)
+- `prev_link`: URL for previous page (if available)
+
+| 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.

{zscaler_sdk_python-1.6.0 → zscaler_sdk_python-1.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.6.0"
+version = "1.7.1"
 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.6.0 → zscaler_sdk_python-1.7.1}/zscaler/__init__.py

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

{zscaler_sdk_python-1.6.0 → zscaler_sdk_python-1.7.1}/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.6.0 → zscaler_sdk_python-1.7.1}/zscaler/helpers.py

@@ -125,7 +125,10 @@ def to_snake_case(string):
         "locationGroupDTO": "location_group_dto",
         "locationDTO": "location_dto",
         "predefinedADPControls": "predefined_adp_controls",
-        "runtimeOS": "runtime_os"
+        "runtimeOS": "runtime_os",
+        
+        # ZIdentity Edge Cases
+        # "clientJWKsUrl": "clientJWKsUrl",
     }
 
     if string in FIELD_EXCEPTIONS:

{zscaler_sdk_python-1.6.0 → zscaler_sdk_python-1.7.1}/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.6.0 → zscaler_sdk_python-1.7.1}/zscaler/oneapi_response.py

@@ -72,11 +72,11 @@ class ZscalerAPIResponse:
             self._params["pagesize"] = self.SERVICE_PAGE_LIMITS["ZPA"]["max"]
 
         # If service is ZIA, ensure the pagination parameter is "pageSize" in camelCase
-        if self._service_type.upper() == "ZIA":
+        if self._service_type == "zia":
             if "page_size" in self._params:
                 self._params["pageSize"] = self._params.pop("page_size")
 
-        if self._service_type.upper() == "ZIA":
+        if self._service_type == "zia":
             # If user supplied pageNumber, initialize self._page accordingly
             if "pageNumber" in self._params:
                 try:
@@ -160,6 +160,14 @@ class ZscalerAPIResponse:
         elif self._service_type == "ZDX":
             self._list = self._body.get("items", [])
             self._next_offset = self._body.get("next_offset")
+        elif self._service_type == "zidentity":
+            # Zidentity uses "records" field for paginated responses
+            self._list = self._body.get("records", [])
+            self._next_link = self._body.get("next_link")
+            self._prev_link = self._body.get("prev_link")
+            self._results_total = self._body.get("results_total")
+            self._page_offset = self._body.get("pageOffset")
+            self._page_size = self._body.get("pageSize")
         else:
             # ZPA and possibly other services use a dict with "list" field
             self._list = self._body.get("list", [])
@@ -267,6 +275,20 @@ class ZscalerAPIResponse:
             # Ensure page parameter is never set for ZIA
             self._params.pop("page", None)
             logger.debug(f"[DEBUG] _fetch_next_page params for ZIA: {self._params}")
+        elif self._service_type == "zidentity":
+            logger.debug("[DEBUG] Taking ZIDENTITY pagination branch.")
+            # For Zidentity, use the next_link URL directly
+            if self._next_link:
+                # Parse the next_link URL to extract parameters
+                from urllib.parse import urlparse, parse_qs
+                parsed_url = urlparse(self._next_link)
+                query_params = parse_qs(parsed_url.query)
+                # Update params with the next page parameters
+                for key, value in query_params.items():
+                    self._params[key] = value[0] if len(value) == 1 else value
+                # Update the URL to the base URL (remove the full next_link)
+                self._url = f"{parsed_url.scheme}://{parsed_url.netloc}{parsed_url.path}"
+            logger.debug(f"[DEBUG] _fetch_next_page params for ZIDENTITY: {self._params}")
         else:
             logger.debug("[DEBUG] Taking ZPA/other pagination branch.")
             self._page += 1
@@ -302,6 +324,11 @@ class ZscalerAPIResponse:
             has_next = self._next_offset is not None
             logger.debug("Has next page for ZDX: %s", has_next)
             return has_next
+        elif self._service_type == "zidentity":
+            # More pages if next_link is not None
+            has_next = self._next_link is not None
+            logger.debug("Has next page for ZIDENTITY: %s", has_next)
+            return has_next
         else:
             # For ZIA/ZCC, if we got results last time, assume we can try next page
             # If next page returns empty, has_next() will be False on next call.