zscaler-sdk-python 1.9.30__tar.gz → 1.9.32__tar.gz

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.9.30
+Version: 1.9.32
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -321,7 +321,7 @@ dropdown you will see the newly created Role. In the event a newly created role
 ZIdentity Admin UI a `Sync Now` button is provided in the API Resources menu which will initiate an
 on-demand sync of newly created roles.
 
-**WARNING**: Attention Government customers. OneAPI and Zidentity is not currently supported for the following ZIA clouds: `zscalergov` and `zscalerten` or ZPA `GOV`, and `GOVUS`.
+**NOTE**: Attention Government customers. OneAPI and Zidentity now support the government (FedRAMP) clouds via the unified `cloud=gov` and `cloud=govus` values. See the [OneAPI Government (FedRAMP) Cloud Environments](#oneapi-government-fedramp-cloud-environments) section below for details.
 
 ### Default Environment Variables
 
@@ -358,6 +358,39 @@ export ZSCALER_CLOUD="beta"
 
 **Note 2**: By default this SDK will send the authentication request and subsequent API calls to the default base URL.
 
+### OneAPI Government (FedRAMP) Cloud Environments
+
+OneAPI supports the Zscaler government (FedRAMP) clouds. These are FedRAMP-isolated environments served by a dedicated Zidentity identity provider and API gateway. To authenticate, set the `cloud` attribute (or `ZSCALER_CLOUD` environment variable) to one of the supported government values:
+
+| `cloud` value | OAuth token endpoint | API base URL |
+|---------------|----------------------|--------------|
+| `gov`         | `https://<vanity_domain>.zidentitygov.net/oauth2/v1/token`   | `https://api.zscalergov.net` |
+| `govus`       | `https://<vanity_domain>.zidentitygovus.net/oauth2/v1/token` | `https://api.zscalergov.us`  |
+
+For example, authenticating to the GOV environment:
+
+```sh
+export ZSCALER_VANITY_DOMAIN="acme"
+export ZSCALER_CLOUD="gov"
+```
+
+Or inline in the client configuration:
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "gov",  # or "govus"
+    "customerId": "",  # Optional parameter. Required only when using ZPA
+    "logging": {"enabled": False, "verbose": False},
+}
+```
+
+**Note**: The `cloud` value is case-insensitive (`gov`, `GOV`, `govus`, `GOVUS` are all accepted). The `vanityDomain` is still required and is used as the host prefix for the government identity provider.
+
 **Note 3**: Authentication to Zscaler Sandbox requires the attribute/parameter `sandboxCloud`.The following cloud environments are supported:
 
 * `zscaler`

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/README.md

@@ -282,7 +282,7 @@ dropdown you will see the newly created Role. In the event a newly created role
 ZIdentity Admin UI a `Sync Now` button is provided in the API Resources menu which will initiate an
 on-demand sync of newly created roles.
 
-**WARNING**: Attention Government customers. OneAPI and Zidentity is not currently supported for the following ZIA clouds: `zscalergov` and `zscalerten` or ZPA `GOV`, and `GOVUS`.
+**NOTE**: Attention Government customers. OneAPI and Zidentity now support the government (FedRAMP) clouds via the unified `cloud=gov` and `cloud=govus` values. See the [OneAPI Government (FedRAMP) Cloud Environments](#oneapi-government-fedramp-cloud-environments) section below for details.
 
 ### Default Environment Variables
 
@@ -319,6 +319,39 @@ export ZSCALER_CLOUD="beta"
 
 **Note 2**: By default this SDK will send the authentication request and subsequent API calls to the default base URL.
 
+### OneAPI Government (FedRAMP) Cloud Environments
+
+OneAPI supports the Zscaler government (FedRAMP) clouds. These are FedRAMP-isolated environments served by a dedicated Zidentity identity provider and API gateway. To authenticate, set the `cloud` attribute (or `ZSCALER_CLOUD` environment variable) to one of the supported government values:
+
+| `cloud` value | OAuth token endpoint | API base URL |
+|---------------|----------------------|--------------|
+| `gov`         | `https://<vanity_domain>.zidentitygov.net/oauth2/v1/token`   | `https://api.zscalergov.net` |
+| `govus`       | `https://<vanity_domain>.zidentitygovus.net/oauth2/v1/token` | `https://api.zscalergov.us`  |
+
+For example, authenticating to the GOV environment:
+
+```sh
+export ZSCALER_VANITY_DOMAIN="acme"
+export ZSCALER_CLOUD="gov"
+```
+
+Or inline in the client configuration:
+
+```py
+from zscaler import ZscalerClient
+
+config = {
+    "clientId": '{yourClientId}',
+    "clientSecret": '{yourClientSecret}',
+    "vanityDomain": '{yourvanityDomain}',
+    "cloud": "gov",  # or "govus"
+    "customerId": "",  # Optional parameter. Required only when using ZPA
+    "logging": {"enabled": False, "verbose": False},
+}
+```
+
+**Note**: The `cloud` value is case-insensitive (`gov`, `GOV`, `govus`, `GOVUS` are all accepted). The `vanityDomain` is still required and is used as the host prefix for the government identity provider.
+
 **Note 3**: Authentication to Zscaler Sandbox requires the attribute/parameter `sandboxCloud`.The following cloud environments are supported:
 
 * `zscaler`

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/pyproject.toml

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

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/zscaler/__init__.py

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

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/zscaler/constants.py

@@ -14,6 +14,20 @@ ZPA_BASE_URLS = {
 
 DEV_AUTH_URL = "https://authn1.dev.zpath.net/authn/v1/oauth/token"
 
+# OneAPI (Zidentity) government cloud endpoints.
+# These environments are FedRAMP-isolated and use a completely different
+# identity provider and API gateway than the commercial clouds. The OneAPI
+# client selects them via the lowercased ``cloud`` parameter (``gov``/``govus``).
+ONEAPI_GOV_AUTH_DOMAINS = {
+    "gov": "zidentitygov.net",
+    "govus": "zidentitygovus.net",
+}
+
+ONEAPI_GOV_API_BASE_URLS = {
+    "gov": "https://api.zscalergov.net",
+    "govus": "https://api.zscalergov.us",
+}
+
 
 RETRYABLE_STATUS_CODES = {429, 500, 502, 503, 504}
 MAX_RETRIES = 5
@@ -23,17 +37,17 @@ BACKOFF_BASE_DURATION = 2
 ZSCALER_ONE_API_DEV = "https://help.zscaler.com/oneapi"
 ZID_DEV = "https://help.zscaler.com/zidentity"
 
-GET_ZSCALER_CLIENT_ID = f"{ZID_DEV}" "/about-api-clients"
+GET_ZSCALER_CLIENT_ID = f"{ZID_DEV}/about-api-clients"
 
-GET_ZSCALER_CLIENT_SECRET = f"{ZID_DEV}" "/about-api-clients"
+GET_ZSCALER_CLIENT_SECRET = f"{ZID_DEV}/about-api-clients"
 
-GET_ZSCALER_VANITY_DOMAIN = f"{ZID_DEV}" "/migrating-zscaler-service-admins-zidentity"
+GET_ZSCALER_VANITY_DOMAIN = f"{ZID_DEV}/migrating-zscaler-service-admins-zidentity"
 
-GET_ZSCALER_CLOUD = f"{ZID_DEV}" "/migrating-zscaler-service-admins-zidentity"
+GET_ZSCALER_CLOUD = f"{ZID_DEV}/migrating-zscaler-service-admins-zidentity"
 
-GET_ZPA_CUSTOMER_ID = f"{ZSCALER_ONE_API_DEV}" "/getting-started#ZPA-customerId-ZSLogin-admin-portal"
+GET_ZPA_CUSTOMER_ID = f"{ZSCALER_ONE_API_DEV}/getting-started#ZPA-customerId-ZSLogin-admin-portal"
 
-GET_ZPA_MICROTENANT_ID = f"{ZSCALER_ONE_API_DEV}" "/getting-started#ZPA-customerId-ZSLogin-admin-portal"
+GET_ZPA_MICROTENANT_ID = f"{ZSCALER_ONE_API_DEV}/getting-started#ZPA-customerId-ZSLogin-admin-portal"
 
 EPOCH_YEAR = 1970
 EPOCH_MONTH = 1

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/zscaler/helpers.py

@@ -285,6 +285,13 @@ def to_lower_camel_case(string):
         "location_dto": "locationDTO",
         "runtime_os": "runtimeOS",
         "default_csp": "defaultCSP",
+        # ZPA Timeout Policy: the API treats "reauth" as a single token. The
+        # default heuristic would split "re_auth_*" into "reAuth*", which the
+        # API rejects. Map both the "re_auth_*" and "reauth_*" spellings.
+        "re_auth_timeout": "reauthTimeout",
+        "re_auth_idle_timeout": "reauthIdleTimeout",
+        "reauth_timeout": "reauthTimeout",
+        "reauth_idle_timeout": "reauthIdleTimeout",
         # ZCC WebPolicy: API expects this top-level key in snake_case.
         "exit_password": "exit_password",
         # ZCC WebPolicy / PolicyExtension: keys with embedded uppercase

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/zscaler/oneapi_oauth_client.py

@@ -15,6 +15,7 @@ from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric import rsa
 from jwcrypto.jwk import JWK
 
+from zscaler.constants import ONEAPI_GOV_AUTH_DOMAINS
 from zscaler.errors.response_checker import check_response_for_error
 from zscaler.user_agent import UserAgent
 
@@ -490,8 +491,14 @@ class OAuth:
         # logging.debug(f"Constructing auth URL for cloud: {cloud}.")
         if cloud == "production":
             return f"https://{vanity_domain}.zslogin.net/oauth2/v1/token"
-        else:
-            return f"https://{vanity_domain}.zslogin{cloud}.net/oauth2/v1/token"
+
+        # Government (FedRAMP) clouds use a dedicated Zidentity identity provider
+        # rather than the commercial ``zslogin{cloud}.net`` family.
+        gov_auth_domain = ONEAPI_GOV_AUTH_DOMAINS.get(cloud)
+        if gov_auth_domain:
+            return f"https://{vanity_domain}.{gov_auth_domain}/oauth2/v1/token"
+
+        return f"https://{vanity_domain}.zslogin{cloud}.net/oauth2/v1/token"
 
     def clear_access_token(self) -> None:
         """

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/zscaler/request_executor.py

@@ -4,6 +4,7 @@ import uuid
 from http import HTTPStatus
 from typing import Any, Dict, Optional, Tuple
 
+from zscaler.constants import ONEAPI_GOV_API_BASE_URLS
 from zscaler.error_messages import ERROR_MESSAGE_429_MISSING_DATE_X_RESET
 from zscaler.errors.response_checker import check_response_for_error
 from zscaler.exceptions import exceptions
@@ -156,21 +157,32 @@ class RequestExecutor:
 
         # Special handling for Z-Insights (zins) GraphQL API
         if "/zins" in endpoint:
-            if self.cloud and self.cloud != "production":
-                return f"https://api.{self.cloud}.zsapi.net"
-            return self.BASE_URL
+            return self._resolve_api_base_url()
 
         # Special handling for ZMS (Microsegmentation) GraphQL API
         if "/zms" in endpoint:
-            if self.cloud and self.cloud != "production":
-                return f"https://api.{self.cloud}.zsapi.net"
-            return self.BASE_URL
+            return self._resolve_api_base_url()
 
         # Special handling for Business Insights (ZBI) API
         if "/bi" in endpoint:
-            if self.cloud and self.cloud != "production":
-                return f"https://api.{self.cloud}.zsapi.net"
-            return self.BASE_URL
+            return self._resolve_api_base_url()
+
+        return self._resolve_api_base_url()
+
+    def _resolve_api_base_url(self) -> str:
+        """
+        Resolves the OneAPI gateway base URL for the configured cloud.
+
+        Government (FedRAMP) clouds are isolated environments served by
+        dedicated gateways (``api.zscalergov.net`` / ``api.zscalergov.us``)
+        and do not follow the commercial ``api.{cloud}.zsapi.net`` pattern.
+
+        Returns:
+            str: The base URL for the configured cloud.
+        """
+        gov_base_url = ONEAPI_GOV_API_BASE_URLS.get(self.cloud)
+        if gov_base_url:
+            return gov_base_url
 
         if self.cloud and self.cloud != "production":
             return f"https://api.{self.cloud}.zsapi.net"
@@ -722,8 +734,7 @@ class RequestExecutor:
                 return None, response, response.text, Exception(ERROR_MESSAGE_429_MISSING_DATE_X_RESET)
 
             logger.info(
-                f"Hit rate limit or retryable status {response.status_code}. "
-                f"Retrying request in {backoff_seconds} seconds."
+                f"Hit rate limit or retryable status {response.status_code}. Retrying request in {backoff_seconds} seconds."
             )
             time.sleep(backoff_seconds)
             attempts += 1
@@ -869,7 +880,7 @@ class RequestExecutor:
             # but only when mutations (POST/PUT/DELETE) have occurred during the session
             if service_type.lower() in ["zia", "ztw"]:
                 logger.debug(
-                    f"{service_type.upper()} service requires explicit deauthentication to activate " f"staged configurations"
+                    f"{service_type.upper()} service requires explicit deauthentication to activate staged configurations"
                 )
 
             # Send DELETE request to deauthenticate

zscaler_sdk_python-1.9.32/zscaler/zia/email_profiles.py

@@ -0,0 +1,279 @@
+"""
+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 typing import List, Optional
+
+from zscaler.api_client import APIClient
+from zscaler.request_executor import RequestExecutor
+from zscaler.types import APIResult
+from zscaler.utils import format_url
+from zscaler.zia.models.email_profiles import EmailProfiles
+
+
+class EmailProfilesAPI(APIClient):
+    """
+    A Client object for the Email profiles resource.
+    """
+
+    _zia_base_endpoint = "/zia/api/v1"
+
+    def __init__(self, request_executor: "RequestExecutor") -> None:
+        super().__init__()
+        self._request_executor: RequestExecutor = request_executor
+
+    def list_email_profiles(self, query_params: Optional[dict] = None) -> APIResult[List[EmailProfiles]]:
+        """
+        Lists email profiles in your organization with pagination.
+        A subset of email profiles can be returned that match a supported
+        filter expression or query.
+
+        Args:
+            query_params {dict}: Map of query parameters for the request.
+                ``[query_params.page]`` {int}: Specifies the page offset.
+
+                ``[query_params.page_size]`` {int}: Page size for pagination.
+
+                ``[query_params.search]`` {str}: Search string for filtering results.
+
+        Returns:
+            tuple: A tuple containing (list of Email Profiles instances, Response, error)
+
+        Examples:
+            List Email Profiles using default settings:
+
+            >>> profile_list, _, error = client.zia.email_profiles.list_email_profiles(
+                query_params={'search': updated_profile.name})
+            >>> if error:
+            ...     print(f"Error listing email profiles: {error}")
+            ...     return
+            ... print(f"Total email profiles found: {len(profile_list)}")
+            ... for profile in profile_list:
+            ...     print(profile.as_dict())
+
+            Client-side filtering with JMESPath:
+
+            The response object supports client-side filtering and
+            projection via ``resp.search(expression)``.  See the
+            `JMESPath documentation <https://jmespath.org/>`_ for
+            expression syntax.
+
+        """
+        http_method = "get".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile
+        """)
+
+        query_params = query_params or {}
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers, params=query_params)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+
+        if error:
+            return (None, response, error)
+
+        try:
+            result = []
+            for item in response.get_results():
+                result.append(EmailProfiles(self.form_response_body(item)))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def get_email_profile(self, profile_id: int) -> APIResult[dict]:
+        """
+        Fetches a specific email profile by ID.
+
+        Args:
+            profile_id (int): The unique identifier for the email profile.
+
+        Returns:
+            tuple: A tuple containing (Email Profile instance, Response, error).
+
+        Examples:
+            Print a specific Email Profile
+
+            >>> fetched_profile, _, error = client.zia.email_profiles.get_email_profile(
+                '1254654')
+            >>> if error:
+            ...     print(f"Error fetching Email Profile by ID: {error}")
+            ...     return
+            ... print(f"Fetched Email Profile by ID: {fetched_profile.as_dict()}")
+        """
+        http_method = "get".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile/{profile_id}
+        """)
+
+        body = {}
+        headers = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, headers)
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, EmailProfiles)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = EmailProfiles(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def add_email_profile(self, **kwargs) -> APIResult[dict]:
+        """
+        Creates a new ZIA Email Profile.
+
+        Args:
+            name (str): The name of the email profile.
+            **kwargs: Optional keyword args.
+
+        Keyword Args:
+            description (str): Additional notes or information
+
+        Returns:
+            tuple: A tuple containing the newly added Email Profile, response, and error.
+
+        Examples:
+            Add a new Email Profile :
+
+            >>> added_profile, _, error = client.zia.email_profiles.add_email_profile(
+            ...     name=f"NewProfile_{random.randint(1000, 10000)}",
+            ...     description=f"NewProfile_{random.randint(1000, 10000)}",
+            ...     emails=['john.doe@example.com', 'mary.jane@example.com']
+            ... )
+            >>> if error:
+            ...     print(f"Error adding email profile: {error}")
+            ...     return
+            ... print(f"Email Profile added successfully: {added_profile.as_dict()}")
+        """
+        http_method = "post".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile
+        """)
+
+        body = kwargs
+
+        request, error = self._request_executor.create_request(
+            method=http_method,
+            endpoint=api_url,
+            body=body,
+        )
+
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, EmailProfiles)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = EmailProfiles(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def update_email_profile(self, profile_id: int, **kwargs) -> APIResult[dict]:
+        """
+        Updates information for the specified ZIA Email Profile.
+
+        Args:
+            profile_id (int): The unique ID for the Email Profile.
+
+        Returns:
+            tuple: A tuple containing the updated Email Profile, response, and error.
+
+        Examples:
+            Update an existing Email Profile :
+
+            >>> updated_profile, _, error = client.zia.email_profiles.update_email_profile(
+                profile_id='1524566'
+            ... name=f"UpdatedEmailProfile_{random.randint(1000, 10000)}",
+            ... description=f"UpdatedEmailProfile_{random.randint(1000, 10000)}",
+            ... )
+            >>> if error:
+            ...     print(f"Error updating Email Profile: {error}")
+            ...     return
+            ... print(f"Email Profile updated successfully: {updated_profile.as_dict()}")
+        """
+        http_method = "put".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile/{profile_id}
+        """)
+        body = kwargs
+
+        request, error = self._request_executor.create_request(http_method, api_url, body, {}, {})
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request, EmailProfiles)
+        if error:
+            return (None, response, error)
+
+        try:
+            result = EmailProfiles(self.form_response_body(response.get_body()))
+        except Exception as error:
+            return (None, response, error)
+        return (result, response, None)
+
+    def delete_email_profile(self, profile_id: int) -> APIResult[dict]:
+        """
+        Deletes the specified Email Profile.
+
+        Args:
+            profile_id (str): The unique identifier of the Email Profile.
+
+        Returns:
+            tuple: A tuple containing the response object and error (if any).
+
+        Examples:
+            Delete an Email Profile:
+
+            >>> _, _, error = client.zia.email_profiles.delete_email_profile('73459')
+            >>> if error:
+            ...     print(f"Error deleting Email Profile: {error}")
+            ...     return
+            ... print(f"Email Profile with ID {'73459'} deleted successfully.")
+        """
+        http_method = "delete".upper()
+        api_url = format_url(f"""
+            {self._zia_base_endpoint}
+            /emailRecipientProfile/{profile_id}
+        """)
+
+        params = {}
+
+        request, error = self._request_executor.create_request(http_method, api_url, params=params)
+        if error:
+            return (None, None, error)
+
+        response, error = self._request_executor.execute(request)
+        if error:
+            return (None, response, error)
+        return (None, response, None)

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/zscaler/zia/legacy.py

@@ -75,6 +75,7 @@ if TYPE_CHECKING:
     from zscaler.zia.dlp_templates import DLPTemplatesAPI
     from zscaler.zia.dlp_web_rules import DLPWebRuleAPI
     from zscaler.zia.dns_gatways import DNSGatewayAPI
+    from zscaler.zia.email_profiles import EmailProfilesAPI
     from zscaler.zia.end_user_notification import EndUserNotificationAPI
     from zscaler.zia.file_type_control_rule import FileTypeControlRuleAPI
     from zscaler.zia.ftp_control_policy import FTPControlPolicyAPI
@@ -1272,6 +1273,13 @@ class LegacyZIAClientHelper:
         """
         return SecureBrowsingAPI(self.request_executor)
 
+    @property
+    def email_profiles(self) -> "EmailProfilesAPI":
+        """
+        The interface object for the :ref:`ZIA Email Profiles API interface <zia-email_profiles>`.
+
+        """
+        return EmailProfilesAPI(self.request_executor)
 
     """
     Misc

zscaler_sdk_python-1.9.32/zscaler/zia/models/email_profiles.py

@@ -0,0 +1,67 @@
+"""
+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.
+"""
+
+# AUTO-GENERATED! DO NOT EDIT FILE DIRECTLY
+# SEE CONTRIBUTOR DOCUMENTATION
+from typing import Any, Dict, List, Optional
+
+from zscaler.oneapi_collection import ZscalerCollection
+from zscaler.oneapi_object import ZscalerObject
+
+
+class EmailProfiles(ZscalerObject):
+    """
+    A class for EmailProfiles objects.
+    """
+
+    def __init__(self, config: Optional[Dict[str, Any]] = None) -> None:
+        """
+        Initialize the EmailProfiles model based on API response.
+
+        Args:
+            config (dict): A dictionary representing the configuration.
+        """
+        super().__init__(config)
+
+        if config:
+            self.id: Optional[Any] = config["id"] \
+                if "id" in config else None
+            self.name: Optional[Any] = config["name"] \
+                if "name" in config else None
+            self.description: Optional[Any] = config["description"] \
+                if "description" in config else None
+            self.emails: List[Any] = ZscalerCollection.form_list(
+                config["emails"] if "emails" in config else [], str
+            )
+        else:
+            self.id: Optional[Any] = None
+            self.name: Optional[Any] = None
+            self.description: Optional[Any] = None
+            self.emails: List[Any] = []
+
+    def request_format(self) -> Dict[str, Any]:
+        """
+        Return the object as a dictionary in the format expected for API requests.
+        """
+        parent_req_format = super().request_format()
+        current_obj_format = {
+            "id": self.id,
+            "name": self.name,
+            "description": self.description,
+            "emails": self.emails
+        }
+        parent_req_format.update(current_obj_format)
+        return parent_req_format

{zscaler_sdk_python-1.9.30 → zscaler_sdk_python-1.9.32}/zscaler/zia/zia_service.py

@@ -48,6 +48,7 @@ from zscaler.zia.dlp_resources import DLPResourcesAPI
 from zscaler.zia.dlp_templates import DLPTemplatesAPI
 from zscaler.zia.dlp_web_rules import DLPWebRuleAPI
 from zscaler.zia.dns_gatways import DNSGatewayAPI
+from zscaler.zia.email_profiles import EmailProfilesAPI
 from zscaler.zia.end_user_notification import EndUserNotificationAPI
 from zscaler.zia.file_type_control_rule import FileTypeControlRuleAPI
 from zscaler.zia.forwarding_control import ForwardingControlAPI
@@ -742,4 +743,12 @@ class ZIAService:
         The interface object for the :ref:`ZIA Secure Browsing API interface <zia-secure_browsing>`.
 
         """
-        return SecureBrowsingAPI(self._request_executor)
+        return SecureBrowsingAPI(self._request_executor)
+    
+    @property
+    def email_profiles(self) -> "EmailProfilesAPI":
+        """
+        The interface object for the :ref:`ZIA Email Profiles API interface <zia-email_profiles>`.
+
+        """
+        return EmailProfilesAPI(self._request_executor)