Skip to main content

PolicyRule Schema

Data structure for Policy Rule objects.

Fields​

FieldTypeRequiredDescriptionNotes
idlongNo--
modified_timeintegerNo-API field: modified_time
creation_timeintegerNo-API field: creation_time
modified_bylongNo-API field: modified_by
namestringYes--
microtenant_idlongNo-API field: microtenant_id
microtenant_namestringNo-API field: microtenant_name
restriction_typestringNo-API field: restriction_type
descriptionstringNo--
rule_orderintegerNo-API field: rule_order
priorityintegerNo--
policy_typeintegerYes-API field: policy_type
operatorstringYes--
action_idlongNo-API field: action_id
actionstringYes--
reauth_timeoutintegerNo-API field: reauth_timeout
reauth_idle_timeoutintegerNo-API field: reauth_idle_timeout
custom_msgstringNo-API field: custom_msg
disabledintegerNo--
service_edge_groupsServiceEdgeGroupWrapperCollectionNo-API field: service_edge_groups
app_connector_groupsAppConnectorGroupWrapperCollectionNo-API field: app_connector_groups
credentialNameIdNo--
credential_poolNameIdNo-API field: credential_pool
zpn_isolation_profile_idlongNo-API field: zpn_isolation_profile_id
zpn_inspection_profile_idlongNo-API field: zpn_inspection_profile_id
post_action_typesstringCollectionNo-API field: post_action_types
post_actionsPolicyRulePostActionsNo-API field: post_actions
zpn_inspection_profile_namestringNo-API field: zpn_inspection_profile_name
extranet_DTOExtranetNo-API field: extranet_DTO
extranet_enabledbooleanNo-API field: extranet_enabled
device_posture_failure_notification_enabledbooleanNo-API field: device_posture_failure_notification_enabled
inconsistent_config_detailsInconsistentConfigDetailsNo-API field: inconsistent_config_details
policy_set_idlongNo-API field: policy_set_id
privileged_capabilitiesPrivilegedCapabilitiesNo-API field: privileged_capabilities
privileged_portal_capabilitiesPrivilegedPortalCapabilitiesNo-API field: privileged_portal_capabilities
conditionsConditionSetWrapperCollectionNo--
app_server_groupsAppServerGroupWrapperCollectionNo-API field: app_server_groups
default_rule_namestringNo-API field: default_rule_name
default_rulebooleanNo-API field: default_rule
read_onlybooleanNo-API field: read_only
zscaler_managedbooleanNo-API field: zscaler_managed
name_without_trimstringNo-API field: name_without_trim

Example​

{
"id": 123,
"modified_time": 123,
"creation_time": 123,
"modified_by": 123,
"name": "string",
"microtenant_id": 123,
"microtenant_name": "string",
"restriction_type": "string"
}
// ... more fields