AdminRole

Admin Role resource for Zscaler Cloud & Branch Connector.

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.

Quick Start

import zssdk
import logging

# Enable debug logging for AdminRole
logging.getLogger('zssdk.ztw').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 AdminRole
resource = session.ztw.AdminRole(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 AdminRole. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
rank	integer	No	-
name	string	Yes	-
policy_access	string	No	-
alerting_access	string	No	-
dashboard_access	string	No	-
report_access	string	No	-
analysis_access	string	No	-
username_access	string	No	-
device_info_access	string	No	-
admin_acct_access	string	No	-
is_auditor	boolean	No	-
permissions	PermissionsEnumCollection	No	-
feature_permissions	ExtFeaturePermissionsEnumRecord	No	-
ext_feature_permissions	ExtFeaturePermissionsEnumRecord	No	-
is_non_editable	boolean	No	-
logs_limit	string	No	-
role_type	string	No	-
report_time_duration	integer	No	-

Returns: AdminRole

Example:

resource = session.ztw.AdminRole()
resource.name = "example-name"
resource.create()
print(f"Created with ID: {resource.id}")

delete()

Deletes a AdminRole by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.ztw.AdminRole(id="your-resource-id")
resource.delete()

load()

Fetches an existing AdminRole by id. Only the id identifier is required; load() takes no other arguments.

Returns: AdminRole

Example:

resource = session.ztw.AdminRole(id="your-resource-id")
resource.load()
print(resource.name)

update()

Updates an existing AdminRole. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
rank	integer	No	-
name	string	Yes	-
policy_access	string	No	-
alerting_access	string	No	-
dashboard_access	string	No	-
report_access	string	No	-
analysis_access	string	No	-
username_access	string	No	-
device_info_access	string	No	-
admin_acct_access	string	No	-
is_auditor	boolean	No	-
permissions	PermissionsEnumCollection	No	-
feature_permissions	ExtFeaturePermissionsEnumRecord	No	-
ext_feature_permissions	ExtFeaturePermissionsEnumRecord	No	-
is_non_editable	boolean	No	-
logs_limit	string	No	-
role_type	string	No	-
report_time_duration	integer	No	-

Returns: AdminRole

Example:

resource = session.ztw.AdminRole(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
id	integer	Yes	-
rank	integer	No	-
name	string	Yes	-
policy_access	string	No	-
alerting_access	string	No	-
dashboard_access	string	No	-
report_access	string	No	-
analysis_access	string	No	-
username_access	string	No	-
device_info_access	string	No	-
admin_acct_access	string	No	-
is_auditor	boolean	No	-
permissions	PermissionsEnumCollection	No	-
feature_permissions	ExtFeaturePermissionsEnumRecord	No	-
ext_feature_permissions	ExtFeaturePermissionsEnumRecord	No	-
is_non_editable	boolean	No	-
logs_limit	string	No	-
role_type	string	No	-
report_time_duration	integer	No	-

Related

• AdminRole - Data structure definition
• Logging guide - enable verbose logs while debugging this resource