zscaler-sdk-python 1.11.1__tar.gz → 1.11.2__tar.gz

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.11.1
+Version: 1.11.2
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/pyproject.toml

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

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/zscaler/__init__.py

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

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/zscaler/zia/models/cloudappcontrol.py

@@ -112,8 +112,10 @@ class CloudApplicationControl(ZscalerObject):
                 config["formSharingDomainProfiles"] if "formSharingDomainProfiles" in config else [],
                 common_reference.ResourceReference,
             )
-            self.cloud_app_risk_profile = ZscalerCollection.form_list(
-                config["cloudAppRiskProfile"] if "cloudAppRiskProfile" in config else [], common_reference.ResourceReference
+            self.cloud_app_risk_profile = (
+                common_reference.ResourceReference(config["cloudAppRiskProfile"])
+                if config.get("cloudAppRiskProfile")
+                else None
             )
 
             # Assign the cbi_profile as-is; conversions are handled by ZscalerObject

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/zscaler/zpa/app_connector_groups.py

@@ -20,6 +20,7 @@ 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.zpa.enrollment_certificates import EnrollmentCertificateAPI
 from zscaler.zpa.models.app_connector_groups import AppConnectorGroup
 
 
@@ -33,6 +34,7 @@ class AppConnectorGroupAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         customer_id = config["client"].get("customerId")
         self._zpa_base_endpoint = f"/zpa/mgmtconfig/v1/admin/customers/{customer_id}"
+        self._enrollment_certificates = EnrollmentCertificateAPI(request_executor, config)
 
     def list_connector_groups(self, query_params: Optional[dict] = None) -> APIResult[List[AppConnectorGroup]]:
         """
@@ -290,9 +292,11 @@ class AppConnectorGroupAPI(APIClient):
                 The version profile to use. This will automatically set ``override_version_profile`` to True.
                 Accepted values are:
                 ``default``, ``previous_default`` and ``new_release``
-            **enrollment_cert_id (str): ID of the enrollment certificate used to sign App Connector enrollment.
-                The SDK does not look this up for you; retrieve it with
-                ``client.zpa.enrollment_certificates.list_enrolment(query_params={"search": "Connector"})``.
+            **enrollment_cert_id (str):
+                ID of the enrollment certificate used for App Connector enrollment. Required by the ZPA API.
+                If not provided, the SDK looks up the ``Connector`` enrollment certificate via
+                ``client.zpa.enrollment_certificates.list_enrolment(query_params={"search": "Connector"})``
+                and sends its ID. Pass it explicitly to use a different certificate.
 
         Returns:
             :obj:`Tuple`: A tuple containing (AppConnectorGroup, Response, error)
@@ -327,6 +331,12 @@ class AppConnectorGroupAPI(APIClient):
         microtenant_id = body.get("microtenant_id", None)
         params = {"microtenantId": microtenant_id} if microtenant_id else {}
 
+        if not body.get("enrollment_cert_id"):
+            cert, _, error = self._enrollment_certificates.get_enrolment_by_name("Connector")
+            if error:
+                return (None, None, error)
+            body["enrollment_cert_id"] = cert.id
+
         # Create the request
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
@@ -384,6 +394,11 @@ class AppConnectorGroupAPI(APIClient):
                 Accepted values are:
 
                 ``default``, ``previous_default`` and ``new_release``
+            **enrollment_cert_id (str):
+                ID of the enrollment certificate used for App Connector enrollment. Required by the ZPA API.
+                If not provided, the SDK looks up the ``Connector`` enrollment certificate via
+                ``client.zpa.enrollment_certificates.list_enrolment(query_params={"search": "Connector"})``
+                and sends its ID. Pass it explicitly to keep a different certificate.
 
         Returns:
             tuple: A tuple containing (AppConnectorGroup, Response, error)
@@ -419,6 +434,12 @@ class AppConnectorGroupAPI(APIClient):
         microtenant_id = body.get("microtenant_id", None)
         params = {"microtenantId": microtenant_id} if microtenant_id else {}
 
+        if not body.get("enrollment_cert_id"):
+            cert, _, error = self._enrollment_certificates.get_enrolment_by_name("Connector")
+            if error:
+                return (None, None, error)
+            body["enrollment_cert_id"] = cert.id
+
         request, error = self._request_executor.create_request(http_method, api_url, body, {}, params)
         if error:
             return (None, None, error)

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/zscaler/zpa/enrollment_certificates.py

@@ -143,6 +143,33 @@ class EnrollmentCertificateAPI(APIClient):
             return (None, response, error)
         return (result, response, None)
 
+    def get_enrolment_by_name(self, name: str) -> APIResult[EnrollmentCertificate]:
+        """
+        Returns the enrollment certificate whose name matches ``name`` (case-insensitive).
+
+        Args:
+            name (str): The name of the enrollment certificate, e.g. ``Connector`` or ``Service Edge``.
+
+        Returns:
+            :obj:`Tuple`: A tuple containing (EnrollmentCertificate, Response, error). If no certificate
+            matches, the error is a ``ValueError``.
+
+        Examples:
+            >>> cert, _, err = client.zpa.enrollment_certificates.get_enrolment_by_name("Connector")
+            ... if err:
+            ...     print(f"Error fetching certificate by name: {err}")
+            ...     return
+            ... print(cert.id)
+        """
+        certs, response, error = self.list_enrolment(query_params={"search": name})
+        if error:
+            return (None, response, error)
+
+        cert = next((c for c in certs or [] if (c.name or "").lower() == name.lower()), None)
+        if cert is None or not cert.id:
+            return (None, response, ValueError(f"Enrollment certificate '{name}' not found"))
+        return (cert, response, None)
+
     def add_enrollment_cert(self, **kwargs) -> APIResult[dict]:
         """
         Creates a new Enrollment Certificate.

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/zscaler/zpa/models/service_edge_groups.py

@@ -42,6 +42,7 @@ class ServiceEdgeGroup(ZscalerObject):
             self.location = config["location"] if "location" in config else None
             self.version_profile_id = config["versionProfileId"] if "versionProfileId" in config else None
             self.version_profile_name = config["versionProfileName"] if "versionProfileName" in config else None
+            self.enrollment_cert_id = config["enrollmentCertId"] if "enrollmentCertId" in config else None
             self.override_version_profile = config["overrideVersionProfile"] if "overrideVersionProfile" in config else None
             self.version_profile_visibility_scope = (
                 config["versionProfileVisibilityScope"] if "versionProfileVisibilityScope" in config else None
@@ -87,6 +88,7 @@ class ServiceEdgeGroup(ZscalerObject):
             self.version_profile_id = None
             self.override_version_profile = None
             self.version_profile_name = None
+            self.enrollment_cert_id = None
             self.upgrade_priority = None
             self.version_profile_visibility_scope = None
             self.alt_cloud = None
@@ -127,6 +129,7 @@ class ServiceEdgeGroup(ZscalerObject):
             "versionProfileId": self.version_profile_id,
             "overrideVersionProfile": self.override_version_profile,
             "versionProfileName": self.version_profile_name,
+            "enrollmentCertId": self.enrollment_cert_id,
             "upgradePriority": self.upgrade_priority,
             "versionProfileVisibilityScope": self.version_profile_visibility_scope,
             "altCloud": self.alt_cloud,

{zscaler_sdk_python-1.11.1 → zscaler_sdk_python-1.11.2}/zscaler/zpa/service_edge_group.py

@@ -20,6 +20,7 @@ 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.zpa.enrollment_certificates import EnrollmentCertificateAPI
 from zscaler.zpa.models.service_edge_groups import ServiceEdgeGroup
 
 
@@ -33,6 +34,7 @@ class ServiceEdgeGroupAPI(APIClient):
         self._request_executor: RequestExecutor = request_executor
         customer_id = config["client"].get("customerId")
         self._zpa_base_endpoint = f"/zpa/mgmtconfig/v1/admin/customers/{customer_id}"
+        self._enrollment_certificates = EnrollmentCertificateAPI(request_executor, config)
 
     def list_service_edge_groups(self, query_params: Optional[dict] = None) -> APIResult[List[ServiceEdgeGroup]]:
         """
@@ -191,9 +193,11 @@ class ServiceEdgeGroupAPI(APIClient):
                 Indicates the grace distance unit of measure in miles or kilometers.
                 This value is only required if graceDistanceEnabled is set to true.
                 Supported Values: `MILES`, `KMS`
-            **enrollment_cert_id (str): ID of the enrollment certificate used to sign Service Edge enrollment.
-                The SDK does not look this up for you; retrieve it with
-                ``client.zpa.enrollment_certificates.list_enrolment(query_params={"search": "Service Edge"})``.
+            **enrollment_cert_id (str):
+                ID of the enrollment certificate used for Service Edge enrollment. Required by the ZPA API.
+                If not provided, the SDK looks up the ``Service Edge`` enrollment certificate via
+                ``client.zpa.enrollment_certificates.list_enrolment(query_params={"search": "Service Edge"})``
+                and sends its ID. Pass it explicitly to use a different certificate.
 
         Returns:
             :obj:`Tuple`: ServiceEdgeGroup: The newly created service edge group object.
@@ -236,6 +240,12 @@ class ServiceEdgeGroupAPI(APIClient):
         if "service_edge_ids" in body:
             body["serviceEdges"] = [{"id": id} for id in body.pop("service_edge_ids")]
 
+        if not body.get("enrollment_cert_id"):
+            cert, _, error = self._enrollment_certificates.get_enrolment_by_name("Service Edge")
+            if error:
+                return (None, None, error)
+            body["enrollment_cert_id"] = cert.id
+
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
             return (None, None, error)
@@ -258,6 +268,13 @@ class ServiceEdgeGroupAPI(APIClient):
             group_id (str): The unique ID of the service edge group.
             microtenant_id (str): The unique identifier of the Microtenant for the ZPA tenant.
 
+        Keyword Args:
+            **enrollment_cert_id (str):
+                ID of the enrollment certificate used for Service Edge enrollment. Required by the ZPA API.
+                If not provided, the SDK looks up the ``Service Edge`` enrollment certificate via
+                ``client.zpa.enrollment_certificates.list_enrolment(query_params={"search": "Service Edge"})``
+                and sends its ID. Pass it explicitly to keep a different certificate.
+
         Returns:
             :obj:`Tuple`: ServiceEdgeGroup: The updated service edge group object.
 
@@ -303,6 +320,12 @@ class ServiceEdgeGroupAPI(APIClient):
         if "service_edge_ids" in body:
             body["serviceEdges"] = [{"id": id} for id in body.pop("service_edge_ids")]
 
+        if not body.get("enrollment_cert_id"):
+            cert, _, error = self._enrollment_certificates.get_enrolment_by_name("Service Edge")
+            if error:
+                return (None, None, error)
+            body["enrollment_cert_id"] = cert.id
+
         request, error = self._request_executor.create_request(http_method, api_url, body=body, params=params)
         if error:
             return (None, None, error)