Microtenant
Microtenant resource for Zscaler Private Access.
Resource operations
This resource supports the following standard methods: load(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.
Quick Start
import zssdk
import logging
# Enable debug logging for Microtenant
logging.getLogger('zssdk.zpa').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)
session = zssdk.Session(
vanity_domain="your-vanity-domain",
client_id="your-client-id",
client_secret="your-client-secret",
)
# Get a specific Microtenant
resource = session.zpa.Microtenant(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
create_microtenant()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | string | No | - |
id | string | No | - |
name | string | No | - |
description | string | No | - |
priority | integer | No | - |
enabled | boolean | No | - |
criteria_attribute | string | No | - |
criteria_attribute_values | stringCollection | No | - |
privileged_approvals_enabled | boolean | No | - |
Example:
resource = session.zpa.Microtenant()
result = resource.create_microtenant(customer_id=3600)
print(result)
delete()
Deletes a Microtenant by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zpa.Microtenant(id="your-resource-id")
resource.delete()
get_all_microtenants()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
sort_by | Sort | No | - |
filter_by | UIFilterWrapperCollection | No | - |
page_by | Pagination | No | - |
Returns: Microtenant
Example:
resource = session.zpa.Microtenant()
result = resource.get_all_microtenants(customer_id=3600)
print(result)
load()
Fetches an existing Microtenant by id. Only the id identifier is required; load() takes no other arguments.
Returns: Microtenant
Example:
resource = session.zpa.Microtenant(id="your-resource-id")
resource.load()
print(resource.name)
update_microtenant()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | string | No | - |
id | string | No | - |
name | string | No | - |
description | string | No | - |
priority | integer | No | - |
enabled | boolean | No | - |
criteria_attribute | string | No | - |
criteria_attribute_values | stringCollection | No | - |
privileged_approvals_enabled | boolean | No | - |
Example:
resource = session.zpa.Microtenant(id="your-resource-id")
result = resource.update_microtenant(customer_id=3600)
print(result)
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | long | No | - |
name | string | Yes | - |
description | string | No | - |
priority | integer | No | - |
enabled | boolean | No | - |
operator | string | Yes | - |
criteria_attribute | string | No | - |
criteria_attribute_values | stringCollection | No | - |
privileged_approvals_enabled | boolean | No | - |
user | UserResource | No | - |
roles | MicrotenantRoleCollection | No | - |
name_without_trim | string | No | - |
scope_order | integer | No | - |
Related
- Microtenant - Data structure definition
- Logging guide - enable verbose logs while debugging this resource