zscaler-sdk-python 2.0.0b1__tar.gz → 2.0.0b2__tar.gz

{zscaler_sdk_python-2.0.0b1/zscaler_sdk_python.egg-info → zscaler_sdk_python-2.0.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zscaler-sdk-python
-Version: 2.0.0b1
+Version: 2.0.0b2
 Summary: Zscaler SDK for Python
 Author-email: "Zscaler Inc." <devrel@zscaler.com>
 License-Expression: MIT
@@ -23,7 +23,11 @@ License-File: LICENSE.md
 Requires-Dist: cryptography>=46.0.0
 Requires-Dist: httpx<2.0.0,>=0.28.0
 Requires-Dist: jmespath>=1.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: PyJWT<3.0.0,>=2.8.0
+Requires-Dist: truststore>=0.9.0
+Provides-Extra: examples
+Requires-Dist: prettytable>=3.0.0; extra == "examples"
 Provides-Extra: dev
 Requires-Dist: black==25.12.0; extra == "dev"
 Requires-Dist: faker>=30.0.0; extra == "dev"
@@ -130,7 +134,7 @@ This SDK uses a resource-oriented design with the following characteristics:
 
 If you are currently using [`zscaler-sdk-python`](https://github.com/zscaler/zscaler-sdk-python), here is why you should switch to `zscaler-sdk-python`:
 
-| Capability | `zscaler-sdk-python` (previous) | `zscaler-sdk-python` (this SDK) |
+| Capability | `zscaler-sdk-python` v1 | `zscaler-sdk-python` v2 |
 |---|---|---|
 | **Data access** | Raw `dict` — `user["name"]` | Resource objects — `user.name` |
 | **CRUD pattern** | Service methods returning `(result, resp, error)` tuples | Active Record — `resource.create()`, `.load()`, `.update()`, `.delete()` |
@@ -297,6 +301,8 @@ client_id = your_beta_client_id
 client_secret = your_beta_client_secret
 ```
 
+> **Note:** Profile names (e.g., `[default]`, `[beta]`) are arbitrary labels you choose. The `cloud` key within a profile is what selects the non-production Zscaler environment. Omit `cloud` entirely for production.
+
 Use a profile by name:
 
 ```python
@@ -392,7 +398,7 @@ The resource layer provides a Pythonic, object-oriented interface. Access servic
 ```python
 import zssdk
 
-session = zssdk.Session(profile_name="beta")
+session = zssdk.Session(profile_name="default")
 zia = session.zia
 
 # Create a new VPN credential
@@ -512,7 +518,7 @@ When you use the `with` statement with `session.zia` or `session.ztw`:
 ```python
 import zssdk
 
-session = zssdk.Session(profile_name="beta")
+session = zssdk.Session(profile_name="default")
 
 # ZIA: context manager activates changes on exit
 with session.zia as zia:
@@ -705,7 +711,7 @@ config = Config(
         log_file_path="/var/log/zssdk.log",
     )
 )
-session = Session(config=config, profile_name="beta")
+session = Session(config=config, profile_name="default")
 ```
 
 **Custom format (programmatic only):**
@@ -722,7 +728,7 @@ config = Config(
         custom_formatter=custom_formatter,
     )
 )
-session = Session(config=config, profile_name="beta")
+session = Session(config=config, profile_name="default")
 ```
 
 Sensitive fields (tokens, secrets, passwords) are redacted in log output.
@@ -760,20 +766,9 @@ When you type `session.zia.` in VS Code or PyCharm, you will see completions for
 
 ## Examples
 
-The repository includes runnable examples under `python/examples/`:
-
-**Zscaler Identity (ZID):**
-
-- `user_management/` — User profile CRUD
-- `group_management/` — Group management
-- `api_client_management/` — API client CRUD
-- `resource_server_management/` — Resource server viewing
-
-**Zscaler Internet Access (ZIA):**
-
-- `vpn_credentials_management/` — VPN credential management
+The repository includes runnable CLI scripts and inline examples under `examples/`, organized by product. Prerequisites and configuration are covered in the [Configuration](#configuration) section above.
 
-Each example directory contains a `README.md` with usage details. Run any script with `--help` for options:
+All CLI scripts are self-documenting. Run any script with no arguments for a usage hint, or `--help` for the full reference:
 
 ```sh
 python examples/zid/user_management/user_management.py --help
@@ -905,7 +900,7 @@ client_secret = ...
 
 ### Quick reference
 
-| What | `zscaler-sdk-python` | `zscaler-sdk-python` |
+| What | `zscaler-sdk-python` v1 | `zscaler-sdk-python` v2 |
 |---|---|---|
 | Import | `from zscaler import ZscalerClient` | `from zssdk import Session` |
 | Access field | `user["name"]` | `user.name` |

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2}/README.md

@@ -87,7 +87,7 @@ This SDK uses a resource-oriented design with the following characteristics:
 
 If you are currently using [`zscaler-sdk-python`](https://github.com/zscaler/zscaler-sdk-python), here is why you should switch to `zscaler-sdk-python`:
 
-| Capability | `zscaler-sdk-python` (previous) | `zscaler-sdk-python` (this SDK) |
+| Capability | `zscaler-sdk-python` v1 | `zscaler-sdk-python` v2 |
 |---|---|---|
 | **Data access** | Raw `dict` — `user["name"]` | Resource objects — `user.name` |
 | **CRUD pattern** | Service methods returning `(result, resp, error)` tuples | Active Record — `resource.create()`, `.load()`, `.update()`, `.delete()` |
@@ -254,6 +254,8 @@ client_id = your_beta_client_id
 client_secret = your_beta_client_secret
 ```
 
+> **Note:** Profile names (e.g., `[default]`, `[beta]`) are arbitrary labels you choose. The `cloud` key within a profile is what selects the non-production Zscaler environment. Omit `cloud` entirely for production.
+
 Use a profile by name:
 
 ```python
@@ -349,7 +351,7 @@ The resource layer provides a Pythonic, object-oriented interface. Access servic
 ```python
 import zssdk
 
-session = zssdk.Session(profile_name="beta")
+session = zssdk.Session(profile_name="default")
 zia = session.zia
 
 # Create a new VPN credential
@@ -469,7 +471,7 @@ When you use the `with` statement with `session.zia` or `session.ztw`:
 ```python
 import zssdk
 
-session = zssdk.Session(profile_name="beta")
+session = zssdk.Session(profile_name="default")
 
 # ZIA: context manager activates changes on exit
 with session.zia as zia:
@@ -662,7 +664,7 @@ config = Config(
         log_file_path="/var/log/zssdk.log",
     )
 )
-session = Session(config=config, profile_name="beta")
+session = Session(config=config, profile_name="default")
 ```
 
 **Custom format (programmatic only):**
@@ -679,7 +681,7 @@ config = Config(
         custom_formatter=custom_formatter,
     )
 )
-session = Session(config=config, profile_name="beta")
+session = Session(config=config, profile_name="default")
 ```
 
 Sensitive fields (tokens, secrets, passwords) are redacted in log output.
@@ -717,20 +719,9 @@ When you type `session.zia.` in VS Code or PyCharm, you will see completions for
 
 ## Examples
 
-The repository includes runnable examples under `python/examples/`:
-
-**Zscaler Identity (ZID):**
-
-- `user_management/` — User profile CRUD
-- `group_management/` — Group management
-- `api_client_management/` — API client CRUD
-- `resource_server_management/` — Resource server viewing
-
-**Zscaler Internet Access (ZIA):**
-
-- `vpn_credentials_management/` — VPN credential management
+The repository includes runnable CLI scripts and inline examples under `examples/`, organized by product. Prerequisites and configuration are covered in the [Configuration](#configuration) section above.
 
-Each example directory contains a `README.md` with usage details. Run any script with `--help` for options:
+All CLI scripts are self-documenting. Run any script with no arguments for a usage hint, or `--help` for the full reference:
 
 ```sh
 python examples/zid/user_management/user_management.py --help
@@ -862,7 +853,7 @@ client_secret = ...
 
 ### Quick reference
 
-| What | `zscaler-sdk-python` | `zscaler-sdk-python` |
+| What | `zscaler-sdk-python` v1 | `zscaler-sdk-python` v2 |
 |---|---|---|
 | Import | `from zscaler import ZscalerClient` | `from zssdk import Session` |
 | Access field | `user["name"]` | `user.name` |

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2}/pyproject.toml

@@ -2,8 +2,8 @@
 # jmespath is required here because it's imported by the SDK,
 # and the SDK is imported during the build process to determine
 # the dynamic version number.
-# PyJWT and httpx are also required for the same reason.
-requires = ["setuptools>=61.0", "jmespath", "PyJWT>=2.8.0,<3.0.0", "httpx>=0.28.0"]
+# PyJWT, httpx, and truststore are also required for the same reason.
+requires = ["setuptools>=61.0", "jmespath", "PyJWT>=2.8.0,<3.0.0", "httpx>=0.28.0", "pydantic>=2.0.0", "truststore>=0.9.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -29,7 +29,9 @@ dependencies = [
     "cryptography>=46.0.0",
     "httpx>=0.28.0,<2.0.0",
     "jmespath>=1.0.0",
+    "pydantic>=2.0.0,<3.0.0",
     "PyJWT>=2.8.0,<3.0.0",
+    "truststore>=0.9.0",
 ]
 
 [project.urls]
@@ -39,6 +41,9 @@ Documentation = "http://automation.zsapidocs.net/docs/"
 "Bug Tracker" = "https://github.com/zscaler/zscaler-sdk-python/issues"
 
 [project.optional-dependencies]
+examples = [
+    "prettytable>=3.0.0",
+]
 dev = [
     "black==25.12.0",
     "faker>=30.0.0",

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2/zscaler_sdk_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zscaler-sdk-python
-Version: 2.0.0b1
+Version: 2.0.0b2
 Summary: Zscaler SDK for Python
 Author-email: "Zscaler Inc." <devrel@zscaler.com>
 License-Expression: MIT
@@ -23,7 +23,11 @@ License-File: LICENSE.md
 Requires-Dist: cryptography>=46.0.0
 Requires-Dist: httpx<2.0.0,>=0.28.0
 Requires-Dist: jmespath>=1.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: PyJWT<3.0.0,>=2.8.0
+Requires-Dist: truststore>=0.9.0
+Provides-Extra: examples
+Requires-Dist: prettytable>=3.0.0; extra == "examples"
 Provides-Extra: dev
 Requires-Dist: black==25.12.0; extra == "dev"
 Requires-Dist: faker>=30.0.0; extra == "dev"
@@ -130,7 +134,7 @@ This SDK uses a resource-oriented design with the following characteristics:
 
 If you are currently using [`zscaler-sdk-python`](https://github.com/zscaler/zscaler-sdk-python), here is why you should switch to `zscaler-sdk-python`:
 
-| Capability | `zscaler-sdk-python` (previous) | `zscaler-sdk-python` (this SDK) |
+| Capability | `zscaler-sdk-python` v1 | `zscaler-sdk-python` v2 |
 |---|---|---|
 | **Data access** | Raw `dict` — `user["name"]` | Resource objects — `user.name` |
 | **CRUD pattern** | Service methods returning `(result, resp, error)` tuples | Active Record — `resource.create()`, `.load()`, `.update()`, `.delete()` |
@@ -297,6 +301,8 @@ client_id = your_beta_client_id
 client_secret = your_beta_client_secret
 ```
 
+> **Note:** Profile names (e.g., `[default]`, `[beta]`) are arbitrary labels you choose. The `cloud` key within a profile is what selects the non-production Zscaler environment. Omit `cloud` entirely for production.
+
 Use a profile by name:
 
 ```python
@@ -392,7 +398,7 @@ The resource layer provides a Pythonic, object-oriented interface. Access servic
 ```python
 import zssdk
 
-session = zssdk.Session(profile_name="beta")
+session = zssdk.Session(profile_name="default")
 zia = session.zia
 
 # Create a new VPN credential
@@ -512,7 +518,7 @@ When you use the `with` statement with `session.zia` or `session.ztw`:
 ```python
 import zssdk
 
-session = zssdk.Session(profile_name="beta")
+session = zssdk.Session(profile_name="default")
 
 # ZIA: context manager activates changes on exit
 with session.zia as zia:
@@ -705,7 +711,7 @@ config = Config(
         log_file_path="/var/log/zssdk.log",
     )
 )
-session = Session(config=config, profile_name="beta")
+session = Session(config=config, profile_name="default")
 ```
 
 **Custom format (programmatic only):**
@@ -722,7 +728,7 @@ config = Config(
         custom_formatter=custom_formatter,
     )
 )
-session = Session(config=config, profile_name="beta")
+session = Session(config=config, profile_name="default")
 ```
 
 Sensitive fields (tokens, secrets, passwords) are redacted in log output.
@@ -760,20 +766,9 @@ When you type `session.zia.` in VS Code or PyCharm, you will see completions for
 
 ## Examples
 
-The repository includes runnable examples under `python/examples/`:
-
-**Zscaler Identity (ZID):**
-
-- `user_management/` — User profile CRUD
-- `group_management/` — Group management
-- `api_client_management/` — API client CRUD
-- `resource_server_management/` — Resource server viewing
-
-**Zscaler Internet Access (ZIA):**
-
-- `vpn_credentials_management/` — VPN credential management
+The repository includes runnable CLI scripts and inline examples under `examples/`, organized by product. Prerequisites and configuration are covered in the [Configuration](#configuration) section above.
 
-Each example directory contains a `README.md` with usage details. Run any script with `--help` for options:
+All CLI scripts are self-documenting. Run any script with no arguments for a usage hint, or `--help` for the full reference:
 
 ```sh
 python examples/zid/user_management/user_management.py --help
@@ -905,7 +900,7 @@ client_secret = ...
 
 ### Quick reference
 
-| What | `zscaler-sdk-python` | `zscaler-sdk-python` |
+| What | `zscaler-sdk-python` v1 | `zscaler-sdk-python` v2 |
 |---|---|---|
 | Import | `from zscaler import ZscalerClient` | `from zssdk import Session` |
 | Access field | `user["name"]` | `user.name` |

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2}/zscaler_sdk_python.egg-info/SOURCES.txt

@@ -51,6 +51,7 @@ zssdk/zscore/zia_client.pyi
 zssdk/zscore/zid_client.pyi
 zssdk/zscore/zpa_client.pyi
 zssdk/zscore/ztw_client.pyi
+zssdk/zscore/data/_errors.json
 zssdk/zscore/data/_retry.json
 zssdk/zscore/data/endpoints.json
 zssdk/zscore/data/exception.json
@@ -58,12 +59,14 @@ zssdk/zscore/data/zcc/v1/paginators-1.json
 zssdk/zscore/data/zcc/v1/service-1.json
 zssdk/zscore/data/zdx/v1/paginators-1.json
 zssdk/zscore/data/zdx/v1/service-1.json
+zssdk/zscore/data/zia/v1/errors-1.json
 zssdk/zscore/data/zia/v1/paginators-1.json
 zssdk/zscore/data/zia/v1/service-1.json
 zssdk/zscore/data/zid/v1/paginators-1.json
 zssdk/zscore/data/zid/v1/service-1.json
 zssdk/zscore/data/zpa/v1/paginators-1.json
 zssdk/zscore/data/zpa/v1/service-1.json
+zssdk/zscore/data/ztw/v1/errors-1.json
 zssdk/zscore/data/ztw/v1/paginators-1.json
 zssdk/zscore/data/ztw/v1/service-1.json
 zssdk/zsresource/__init__.py

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2}/zscaler_sdk_python.egg-info/requires.txt

@@ -1,7 +1,9 @@
 cryptography>=46.0.0
 httpx<2.0.0,>=0.28.0
 jmespath>=1.0.0
+pydantic<3.0.0,>=2.0.0
 PyJWT<3.0.0,>=2.8.0
+truststore>=0.9.0
 
 [dev]
 black==25.12.0
@@ -18,3 +20,6 @@ anyio==4.12.0
 autopep8==2.3.2
 tomlkit==0.13.3
 uv==0.9.21
+
+[examples]
+prettytable>=3.0.0

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2}/zssdk/__version__.py

@@ -14,4 +14,4 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 """
 
-__version__ = "2.0.0b1"
+__version__ = "2.0.0b2"

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2}/zssdk/session.py

@@ -16,8 +16,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 # /Users/kakella/gitlab/oneapi/oneapi-sdk/python/zssdk/session.py
 
 import threading
-from dataclasses import asdict, dataclass, field
-from typing import Optional
+from dataclasses import dataclass, fields
+from typing import Optional, Union
+
+from pydantic import SecretStr
 
 import zssdk.zscore.session
 
@@ -37,17 +39,31 @@ class ClientParams:
     cloud: Optional[str] = None
     vanity_domain: Optional[str] = None
     client_id: Optional[str] = None
-    client_secret: Optional[str] = field(default=None, repr=False)
-    private_key: Optional[str] = field(default=None, repr=False)
+    client_secret: Optional[Union[str, SecretStr]] = None
+    private_key: Optional[Union[str, SecretStr]] = None
     cert_file_path: Optional[str] = None
     token_provider: Optional[TokenProvider] = None
     api_version: Optional[str] = None
     customer_id: Optional[str] = None
     config: Optional[object] = None  # zssdk.zscore.config.Config
 
+    def __post_init__(self):
+        if self.client_secret is not None and not isinstance(self.client_secret, SecretStr):
+            self.client_secret = SecretStr(self.client_secret)
+        if self.private_key is not None and not isinstance(self.private_key, SecretStr):
+            self.private_key = SecretStr(self.private_key)
+
     def to_dict(self):
-        """Convert to dict, excluding None values."""
-        return {k: v for k, v in asdict(self).items() if v is not None}
+        """Convert to dict, excluding None values. SecretStr values are unwrapped."""
+        result = {}
+        for f in fields(self):
+            value = getattr(self, f.name)
+            if value is not None:
+                if isinstance(value, SecretStr):
+                    result[f.name] = value.get_secret_value()
+                else:
+                    result[f.name] = value
+        return result
 
 
 class Session:

{zscaler_sdk_python-2.0.0b1 → zscaler_sdk_python-2.0.0b2}/zssdk/zscore/auth.py

@@ -66,6 +66,27 @@ class _HttpxAuthProvider(httpx.Auth):
             else:
                 raise
 
+    def force_refresh(self):
+        """
+        Invalidate the cached token so the next outbound request triggers a
+        fresh fetch via :meth:`auth_flow`.
+
+        Used by the body-aware reactive retry loop in
+        :meth:`BaseZsClient._execute_with_reactive_retry` when the API signals
+        ``SESSION_NOT_VALID`` / "Session already invalidated" — the in-memory
+        token has been revoked server-side, so the safest recovery is to throw
+        it away and let the next request trigger ``_refresh_token()`` under
+        the existing lock.
+
+        Thread-safe: uses the same lock as :meth:`_refresh_token`. If multiple
+        threads observe a 401 and all call this method, the worst case is a
+        small number of redundant refreshes — never a stale-token loop.
+        """
+        with self._lock:
+            self.sdk_logger.logger.info("Token recycle: invalidating cached token (reactive refresh)")
+            self._token = None
+            self._expiry_time = 0
+
     def auth_flow(self, request: httpx.Request):
         """The entry point for httpx's authentication mechanism."""
         if self._is_expired():