PolicyRuleResource

Policy Rule Resource resource for Zscaler Private Access V2.

Resource operations

This resource does not support standard CRUDL methods. Each action listed below is a custom action that takes explicit keyword arguments and returns a value.

Quick Start

import zssdk
from zssdk.zscore.config import Config

config = Config(api_version="v2")
import logging

# Enable debug logging for PolicyRuleResource
logging.getLogger('zssdk.zpa').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)

session = zssdk.Session(
    config=config,
    vanity_domain="your-vanity-domain",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# Call add_rule_to_policy_set on PolicyRuleResource
resource = session.zpa.PolicyRuleResource()
result = resource.add_rule_to_policy_set(action="value", name="example-name")
print(result)

# Debug output shows HTTP request/response details

Actions

add_rule_to_policy_set()

Parameters:

Name	Type	Required	Description
customer_id	long	No	-
id	long	No	-
microtenant_id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	string	No	-
id	string	No	-
microtenant_name	string	No	-
restriction_type	string	No	-
action	string	Yes	-
app_server_groups	PolicyRuleAppServerGroupWrapperCollection	No	-
service_edge_groups	PolicyRuleServiceEdgeGroupWrapperCollection	No	-
app_connector_groups	PolicyRuleAppConnectorGroupWrapperCollection	No	-
conditions	PolicyRuleConditionSetWrapperCollection	No	-
extranet_enabled	boolean	No	-
extranet_DTO	Extranet	No	-
device_posture_failure_notification_enabled	boolean	No	-
custom_msg	string	No	-
description	string	No	-
reauth_timeout	integer	No	-
reauth_idle_timeout	integer	No	-
version	long	No	-
disabled	integer	No	-
name	string	Yes	-
policy_set_id	long	No	-
rule_order	integer	No	-
zpn_isolation_profile_id	long	No	-
priority	integer	No	-
operator	string	No	-
policy_type	integer	No	-
action_id	long	No	-
zpn_inspection_profile_id	long	No	-
zpn_inspection_profile_name	string	No	-
credential	NameId	No	-
credential_pool	NameId	No	-
privileged_capabilities	PolicyRuleCapabilities	No	-
privileged_portal_capabilities	PolicyRuleCapabilities	No	-
post_actions	PolicyRulePostActions	No	-
read_only	boolean	No	-
zscaler_managed	boolean	No	-

Example:

resource = session.zpa.PolicyRuleResource()
result = resource.add_rule_to_policy_set(action="value", name="example-name")
print(result)

update_rule_to_policy_set()

Parameters:

Name	Type	Required	Description
customer_id	long	No	-
id	long	No	-
rule_id	long	No	-
microtenant_id	long	No	-
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	string	No	-
id	string	No	-
microtenant_name	string	No	-
restriction_type	string	No	-
action	string	Yes	-
app_server_groups	PolicyRuleAppServerGroupWrapperCollection	No	-
service_edge_groups	PolicyRuleServiceEdgeGroupWrapperCollection	No	-
app_connector_groups	PolicyRuleAppConnectorGroupWrapperCollection	No	-
conditions	PolicyRuleConditionSetWrapperCollection	No	-
extranet_enabled	boolean	No	-
extranet_DTO	Extranet	No	-
device_posture_failure_notification_enabled	boolean	No	-
custom_msg	string	No	-
description	string	No	-
reauth_timeout	integer	No	-
reauth_idle_timeout	integer	No	-
version	long	No	-
disabled	integer	No	-
name	string	Yes	-
policy_set_id	long	No	-
rule_order	integer	No	-
zpn_isolation_profile_id	long	No	-
priority	integer	No	-
operator	string	No	-
policy_type	integer	No	-
action_id	long	No	-
zpn_inspection_profile_id	long	No	-
zpn_inspection_profile_name	string	No	-
credential	NameId	No	-
credential_pool	NameId	No	-
privileged_capabilities	PolicyRuleCapabilities	No	-
privileged_portal_capabilities	PolicyRuleCapabilities	No	-
post_actions	PolicyRulePostActions	No	-
read_only	boolean	No	-
zscaler_managed	boolean	No	-

Example:

resource = session.zpa.PolicyRuleResource()
result = resource.update_rule_to_policy_set(action="value", name="example-name")
print(result)

Attributes

Name	Type	Required	Description
modified_time	integer	No	-
creation_time	integer	No	-
modified_by	string	No	-
id	string	No	-
microtenant_id	long	No	-
microtenant_name	string	No	-
restriction_type	string	No	-
action	string	Yes	-
app_server_groups	PolicyRuleAppServerGroupWrapperCollection	No	-
service_edge_groups	PolicyRuleServiceEdgeGroupWrapperCollection	No	-
app_connector_groups	PolicyRuleAppConnectorGroupWrapperCollection	No	-
conditions	PolicyRuleConditionSetWrapperCollection	No	-
extranet_enabled	boolean	No	-
extranet_DTO	Extranet	No	-
device_posture_failure_notification_enabled	boolean	No	-
custom_msg	string	No	-
description	string	No	-
reauth_timeout	integer	No	-
reauth_idle_timeout	integer	No	-
version	long	No	-
disabled	integer	No	-
name	string	Yes	-
policy_set_id	long	No	-
rule_order	integer	No	-
zpn_isolation_profile_id	long	No	-
priority	integer	No	-
operator	string	No	-
policy_type	integer	No	-
action_id	long	No	-
zpn_inspection_profile_id	long	No	-
zpn_inspection_profile_name	string	No	-
credential	NameId	No	-
credential_pool	NameId	No	-
privileged_capabilities	PolicyRuleCapabilities	No	-
privileged_portal_capabilities	PolicyRuleCapabilities	No	-
post_actions	PolicyRulePostActions	No	-
read_only	boolean	No	-
zscaler_managed	boolean	No	-

Related

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