TenancyRestrictionProfile
Tenancy Restriction Profile resource for Zscaler Internet Access.
This resource supports the following standard methods: create(), load(), update(), 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 TenancyRestrictionProfile
logging.getLogger('zssdk.zia').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 TenancyRestrictionProfile
resource = session.zia.TenancyRestrictionProfile(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()
Creates a new TenancyRestrictionProfile. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
allow_gcp_cloud_storage_read | boolean | No | - |
allow_google_consumers | boolean | No | - |
allow_google_visitors | boolean | No | - |
app_type | string | No | - |
description | string | No | - |
id | integer | No | - |
item_data_primary | stringCollection | No | - |
item_data_secondary | stringCollection | No | - |
item_type_primary | string | No | - |
item_type_secondary | string | No | - |
item_value | ItemValueEnumCollection | No | - |
ms_login_services_tr_v2 | boolean | No | - |
name | string | No | - |
restrict_personal_o365_domains | boolean | No | - |
Returns: TenancyRestrictionProfile
Example:
resource = session.zia.TenancyRestrictionProfile()
resource.allow_gcp_cloud_storage_read = True
resource.allow_google_consumers = True
resource.allow_google_visitors = True
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a TenancyRestrictionProfile by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.TenancyRestrictionProfile(id="your-resource-id")
resource.delete()
get_tenancy_restriction_profile_app_item_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app_type | string | Yes | - |
item_type | string | Yes | - |
exclude_profile | integer | No | - |
Example:
resource = session.zia.TenancyRestrictionProfile()
result = resource.get_tenancy_restriction_profile_app_item_count(app_type="value", item_type="value")
print(result)
load()
Fetches an existing TenancyRestrictionProfile by id. Only the id identifier is required; load() takes no other arguments.
Returns: TenancyRestrictionProfile
Example:
resource = session.zia.TenancyRestrictionProfile(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing TenancyRestrictionProfile. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
allow_gcp_cloud_storage_read | boolean | No | - |
allow_google_consumers | boolean | No | - |
allow_google_visitors | boolean | No | - |
app_type | string | No | - |
description | string | No | - |
id | integer | Yes | - |
item_data_primary | stringCollection | No | - |
item_data_secondary | stringCollection | No | - |
item_type_primary | string | No | - |
item_type_secondary | string | No | - |
item_value | ItemValueEnumCollection | No | - |
ms_login_services_tr_v2 | boolean | No | - |
name | string | No | - |
restrict_personal_o365_domains | boolean | No | - |
Returns: TenancyRestrictionProfile
Example:
resource = session.zia.TenancyRestrictionProfile(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
allow_gcp_cloud_storage_read | boolean | No | - |
allow_google_consumers | boolean | No | - |
allow_google_visitors | boolean | No | - |
app_type | string | No | - |
description | string | No | - |
id | integer | No | - |
item_data_primary | stringCollection | No | - |
item_data_secondary | stringCollection | No | - |
item_type_primary | string | No | - |
item_type_secondary | string | No | - |
item_value | ItemValueEnumCollection | No | - |
ms_login_services_tr_v2 | boolean | No | - |
name | string | No | - |
restrict_personal_o365_domains | boolean | No | - |
Related
- TenancyRestrictionProfile - Data structure definition
- Logging guide - enable verbose logs while debugging this resource