CASBDlpRule
C A S B Dlp Rule 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.
Quick Start
import zssdk
import logging
# Enable debug logging for CASBDlpRule
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 CASBDlpRule
resource = session.zia.CASBDlpRule(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 CASBDlpRule. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | Yes | - |
auditor | EntityReference | No | - |
auditor_notification | EntityReference | No | - |
bucket_owner | string | No | - |
buckets | EntityReferenceWrapperCollection | No | - |
casb_email_label | EntityReference | No | - |
casb_tombstone_template | EntityReference | No | - |
cloud_app_tenants | EntityReferenceWrapperCollection | No | - |
collaboration_scope | CollaborationScopeEnumCollection | No | - |
components | ComponentsEnumCollection | No | - |
content_location | string | No | - |
criteria_domain_profiles | EntityReferenceWrapperCollection | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dlp_engines | EntityReferenceWrapperCollection | No | - |
domains | stringCollection | No | - |
email_recipient_profiles | EntityReferenceWrapperCollection | No | - |
entity_groups | EntityReferenceWrapperCollection | No | - |
excluded_domain_profiles | EntityReferenceWrapperCollection | No | - |
external_auditor_email | string | No | - |
file_sharing_expiry_time | integer | No | - |
file_sharing_expiry_time_type | string | No | - |
file_types | FileTypeWrapperCollection | No | - |
groups | EntityReferenceWrapperCollection | No | - |
include_criteria_domain_profile | boolean | No | - |
include_email_recipient_profile | boolean | No | - |
include_entity_groups | boolean | No | - |
included_domain_profiles | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
name | string | Yes | - |
number_of_external_collaborators | string | No | - |
number_of_internal_collaborators | string | No | - |
object_types | CasbDlpObjectTypeWrapperCollection | No | - |
order | integer | Yes | - |
quarantine_location | string | No | - |
rank | integer | No | - |
receiver | IncidentReceiverReference | No | - |
recipient | string | No | - |
redaction_profile | EntityReference | No | - |
severity | string | Yes | - |
state | string | Yes | - |
tag | EntityReference | No | - |
template_synced_rule_flag | string | No | - |
type | string | Yes | - |
users | EntityReferenceWrapperCollection | No | - |
watermark_delete_old_version | boolean | No | - |
watermark_profile | EntityReference | No | - |
without_content_inspection | boolean | No | - |
Returns: CASBDlpRule
Example:
resource = session.zia.CASBDlpRule()
resource.action = "value"
resource.name = "example-name"
resource.order = 3600
resource.severity = "value"
resource.state = "value"
resource.type = "value"
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a CASBDlpRule by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.CASBDlpRule(id="your-resource-id")
resource.delete()
load()
Fetches an existing CASBDlpRule by id. Only the id identifier is required; load() takes no other arguments.
Returns: CASBDlpRule
Example:
resource = session.zia.CASBDlpRule(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing CASBDlpRule. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | Yes | - |
auditor | EntityReference | No | - |
auditor_notification | EntityReference | No | - |
bucket_owner | string | No | - |
buckets | EntityReferenceWrapperCollection | No | - |
casb_email_label | EntityReference | No | - |
casb_tombstone_template | EntityReference | No | - |
cloud_app_tenants | EntityReferenceWrapperCollection | No | - |
collaboration_scope | CollaborationScopeEnumCollection | No | - |
components | ComponentsEnumCollection | No | - |
content_location | string | No | - |
criteria_domain_profiles | EntityReferenceWrapperCollection | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dlp_engines | EntityReferenceWrapperCollection | No | - |
domains | stringCollection | No | - |
email_recipient_profiles | EntityReferenceWrapperCollection | No | - |
entity_groups | EntityReferenceWrapperCollection | No | - |
excluded_domain_profiles | EntityReferenceWrapperCollection | No | - |
external_auditor_email | string | No | - |
file_sharing_expiry_time | integer | No | - |
file_sharing_expiry_time_type | string | No | - |
file_types | FileTypeWrapperCollection | No | - |
groups | EntityReferenceWrapperCollection | No | - |
include_criteria_domain_profile | boolean | No | - |
include_email_recipient_profile | boolean | No | - |
include_entity_groups | boolean | No | - |
included_domain_profiles | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
name | string | Yes | - |
number_of_external_collaborators | string | No | - |
number_of_internal_collaborators | string | No | - |
object_types | CasbDlpObjectTypeWrapperCollection | No | - |
order | integer | Yes | - |
quarantine_location | string | No | - |
rank | integer | No | - |
receiver | IncidentReceiverReference | No | - |
recipient | string | No | - |
redaction_profile | EntityReference | No | - |
severity | string | Yes | - |
state | string | Yes | - |
tag | EntityReference | No | - |
template_synced_rule_flag | string | No | - |
type | string | Yes | - |
users | EntityReferenceWrapperCollection | No | - |
watermark_delete_old_version | boolean | No | - |
watermark_profile | EntityReference | No | - |
without_content_inspection | boolean | No | - |
Returns: CASBDlpRule
Example:
resource = session.zia.CASBDlpRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
access_control | string | No | - |
action | string | Yes | - |
auditor | EntityReference | No | - |
auditor_notification | EntityReference | No | - |
bucket_owner | string | No | - |
buckets | EntityReferenceWrapperCollection | No | - |
casb_email_label | EntityReference | No | - |
casb_tombstone_template | EntityReference | No | - |
cloud_app_tenants | EntityReferenceWrapperCollection | No | - |
collaboration_scope | CollaborationScopeEnumCollection | No | - |
components | ComponentsEnumCollection | No | - |
content_location | string | No | - |
criteria_domain_profiles | EntityReferenceWrapperCollection | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
device_groups | EntityReferenceWrapperCollection | No | - |
device_trust_levels | DeviceTrustLevelsEnumCollection | No | - |
devices | EntityReferenceWrapperCollection | No | - |
dlp_engines | EntityReferenceWrapperCollection | No | - |
domains | stringCollection | No | - |
email_recipient_profiles | EntityReferenceWrapperCollection | No | - |
entity_groups | EntityReferenceWrapperCollection | No | - |
excluded_domain_profiles | EntityReferenceWrapperCollection | No | - |
external_auditor_email | string | No | - |
file_sharing_expiry_time | integer | No | - |
file_sharing_expiry_time_type | string | No | - |
file_types | FileTypeWrapperCollection | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | No | - |
include_criteria_domain_profile | boolean | No | - |
include_email_recipient_profile | boolean | No | - |
include_entity_groups | boolean | No | - |
included_domain_profiles | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
name | string | Yes | - |
number_of_external_collaborators | string | No | - |
number_of_internal_collaborators | string | No | - |
object_types | CasbDlpObjectTypeWrapperCollection | No | - |
order | integer | Yes | - |
quarantine_location | string | No | - |
rank | integer | No | - |
receiver | IncidentReceiverReference | No | - |
recipient | string | No | - |
redaction_profile | EntityReference | No | - |
severity | string | Yes | - |
state | string | Yes | - |
tag | EntityReference | No | - |
template_synced_rule_flag | string | No | - |
type | string | Yes | - |
users | EntityReferenceWrapperCollection | No | - |
watermark_delete_old_version | boolean | No | - |
watermark_profile | EntityReference | No | - |
without_content_inspection | boolean | No | - |
Related
- CASBDlpRule - Data structure definition
- Logging guide - enable verbose logs while debugging this resource