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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.7.0
+Version: 1.7.2
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -814,6 +814,69 @@ This SDK supports programmatic integration with the Zscaler ZIdentity API servic
 
 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` |

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

@@ -775,6 +775,69 @@ This SDK supports programmatic integration with the Zscaler ZIdentity API servic
 
 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` |

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.7.0"
+version = "1.7.2"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"

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

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

{zscaler_sdk_python-1.7.0 → zscaler_sdk_python-1.7.2}/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.

{zscaler_sdk_python-1.7.0 → zscaler_sdk_python-1.7.2}/zscaler/zidentity/api_client.py

@@ -60,7 +60,7 @@ class APIClientAPI(APIClient):
             ... if error:
             ...     print(f"Error listing clients: {error}")
             ...     return
-            ... for client in client_list:
+            ... for client in client_list.records:
             ...     print(client.as_dict())
 
             List clients, limiting to a maximum of 10 items:
@@ -69,7 +69,7 @@ class APIClientAPI(APIClient):
             ... if error:
             ...     print(f"Error listing clients: {error}")
             ...     return
-            ... for client in client_list:
+            ... for client in client_list.records:
             ...     print(client.as_dict())
 
         """
@@ -96,9 +96,7 @@ class APIClientAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = []
-            for item in response.get_results():
-                result.append(APIClients(self.form_response_body(item)))
+            result = APIClients(self.form_response_body(response.get_body()))
         except Exception as error:
             return (None, response, error)
 

{zscaler_sdk_python-1.7.0 → zscaler_sdk_python-1.7.2}/zscaler/zidentity/groups.py

@@ -60,7 +60,7 @@ class GroupsAPI(APIClient):
             ... if error:
             ...     print(f"Error listing groups: {error}")
             ...     return
-            ... for group in group_list:
+            ... for resource in group_list.records:
             ...     print(group.as_dict())
 
             List groups, limiting to a maximum of 10 items:
@@ -69,7 +69,7 @@ class GroupsAPI(APIClient):
             ... if error:
             ...     print(f"Error listing groups: {error}")
             ...     return
-            ... for group in department_list:
+            ... for resource in group_list.records:
             ...     print(group.as_dict())
 
         """
@@ -96,9 +96,7 @@ class GroupsAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = []
-            for item in response.get_results():
-                result.append(Groups(self.form_response_body(item)))
+            result = Groups(self.form_response_body(response.get_body()))
         except Exception as error:
             return (None, response, error)
 
@@ -343,7 +341,7 @@ class GroupsAPI(APIClient):
             ... if error:
             ...     print(f"Error listing users: {error}")
             ...     return
-            ... for user in users_list:
+            ... for user in users_list.records:
             ...     print(user.as_dict())
 
             List users, limiting to a maximum of 10 items:
@@ -371,9 +369,7 @@ class GroupsAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = []
-            for item in response.get_results():
-                result.append(Groups(self.form_response_body(item)))
+            result = Groups(self.form_response_body(response.get_body()))
         except Exception as error:
             return (None, response, error)
 

{zscaler_sdk_python-1.7.0 → zscaler_sdk_python-1.7.2}/zscaler/zidentity/models/resource_servers.py

@@ -44,7 +44,7 @@ class ResourceServers(ZscalerObject):
                 if "next_link" in config else None
             self.prev_link = config["prev_link"] \
                 if "prev_link" in config else None
-            self.entity_groups = ZscalerCollection.form_list(
+            self.records = ZscalerCollection.form_list(
                 config["records"] if "records" in config else [], ResourceServersRecord
             )
         else:

{zscaler_sdk_python-1.7.0 → zscaler_sdk_python-1.7.2}/zscaler/zidentity/models/users.py

@@ -16,7 +16,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
 from zscaler.oneapi_object import ZscalerObject
 from zscaler.oneapi_collection import ZscalerCollection
-from zscaler.zidentity.models import groups as groups
 from zscaler.zidentity.models import common
 
 
@@ -45,7 +44,7 @@ class Users(ZscalerObject):
                 if "next_link" in config else None
             self.prev_link = config["prev_link"] \
                 if "prev_link" in config else None
-            self.entity_groups = ZscalerCollection.form_list(
+            self.records = ZscalerCollection.form_list(
                 config["records"] if "records" in config else [], UserRecord
             )
         else:

{zscaler_sdk_python-1.7.0 → zscaler_sdk_python-1.7.2}/zscaler/zidentity/resource_servers.py

@@ -62,7 +62,7 @@ class ResourceServersAPI(APIClient):
             ... if error:
             ...     print(f"Error listing resource servers: {error}")
             ...     return
-            ... for resource in resource_list:
+            ... for resource in resource_list.records:
             ...     print(resource.as_dict())
 
             List resource servers, limiting to a maximum of 10 items:
@@ -71,7 +71,7 @@ class ResourceServersAPI(APIClient):
             ... if error:
             ...     print(f"Error listing resource servers: {error}")
             ...     return
-            ... for resource in resource_list:
+            ... for resource in resource_list.records:
             ...     print(resource.as_dict())
 
         """
@@ -98,9 +98,7 @@ class ResourceServersAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = []
-            for item in response.get_results():
-                result.append(ResourceServers(self.form_response_body(item)))
+            result = ResourceServers(self.form_response_body(response.get_body()))
         except Exception as error:
             return (None, response, error)
 

{zscaler_sdk_python-1.7.0 → zscaler_sdk_python-1.7.2}/zscaler/zidentity/users.py

@@ -69,7 +69,7 @@ class UsersAPI(APIClient):
             ... if error:
             ...     print(f"Error listing users: {error}")
             ...     return
-            ... for user in user_list:
+            ... for user in user_list.records:
             ...     print(user.as_dict())
 
             List users, limiting to a maximum of 10 items:
@@ -78,7 +78,7 @@ class UsersAPI(APIClient):
             ... if error:
             ...     print(f"Error listing users: {error}")
             ...     return
-            ... for user in user_list:
+            ... for user in user_list.records:
             ...     print(user.as_dict())
 
         """
@@ -105,9 +105,7 @@ class UsersAPI(APIClient):
             return (None, response, error)
 
         try:
-            result = []
-            for item in response.get_results():
-                result.append(Users(self.form_response_body(item)))
+            result = Users(self.form_response_body(response.get_body()))
         except Exception as error:
             return (None, response, error)