Skip to main content

TenancyRestrictionProfile

Tenancy Restriction Profile resource for Zscaler Internet Access.

Resource operations

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​

NameTypeDescription
idstringUnique identifier

Actions​

create()​

Creates a new TenancyRestrictionProfile. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

NameTypeRequiredDescription
allow_gcp_cloud_storage_readbooleanNo-
allow_google_consumersbooleanNo-
allow_google_visitorsbooleanNo-
app_typestringNo-
descriptionstringNo-
idintegerNo-
item_data_primarystringCollectionNo-
item_data_secondarystringCollectionNo-
item_type_primarystringNo-
item_type_secondarystringNo-
item_valueItemValueEnumCollectionNo-
ms_login_services_tr_v2booleanNo-
namestringNo-
restrict_personal_o365_domainsbooleanNo-

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:

NameTypeRequiredDescription
app_typestringYes-
item_typestringYes-
exclude_profileintegerNo-

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:

NameTypeRequiredDescription
allow_gcp_cloud_storage_readbooleanNo-
allow_google_consumersbooleanNo-
allow_google_visitorsbooleanNo-
app_typestringNo-
descriptionstringNo-
idintegerYes-
item_data_primarystringCollectionNo-
item_data_secondarystringCollectionNo-
item_type_primarystringNo-
item_type_secondarystringNo-
item_valueItemValueEnumCollectionNo-
ms_login_services_tr_v2booleanNo-
namestringNo-
restrict_personal_o365_domainsbooleanNo-

Returns: TenancyRestrictionProfile

Example:

resource = session.zia.TenancyRestrictionProfile(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes​

NameTypeRequiredDescription
allow_gcp_cloud_storage_readbooleanNo-
allow_google_consumersbooleanNo-
allow_google_visitorsbooleanNo-
app_typestringNo-
descriptionstringNo-
idintegerNo-
item_data_primarystringCollectionNo-
item_data_secondarystringCollectionNo-
item_type_primarystringNo-
item_type_secondarystringNo-
item_valueItemValueEnumCollectionNo-
ms_login_services_tr_v2booleanNo-
namestringNo-
restrict_personal_o365_domainsbooleanNo-