EmailDlpRule
Email 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. 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 EmailDlpRule
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 EmailDlpRule
resource = session.zia.EmailDlpRule(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 EmailDlpRule. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
action | string | No | - |
auditor | EntityReference | No | - |
content_locations | ContentLocationsEnumCollection | No | - |
custom_header | string | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dlp_engines | EntityReferenceWrapperCollection | No | - |
email_recipient_profiles | EntityReferenceWrapperCollection | No | - |
email_tenants | EntityReferenceWrapperCollection | No | - |
excluded_departments | EntityReferenceWrapperCollection | No | - |
excluded_groups | EntityReferenceWrapperCollection | No | - |
excluded_users | EntityReferenceWrapperCollection | No | - |
external_auditor_email | string | No | - |
file_type_categories | FileTypeCategoryWrapperCollection | No | - |
file_types | stringCollection | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | No | - |
included_domain_profiles | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
min_size | integer | No | - |
name | string | No | - |
notification_template | EntityReference | No | - |
order | integer | No | - |
parent_rule | integer | No | - |
receiver | IncidentReceiverReference | No | - |
severity | string | No | - |
state | string | No | - |
sub_rules | EmailDlpRuleWrapperCollection | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
user_risk_score_levels | UserRiskScoreLevelsEnumCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
without_content_inspection | boolean | No | - |
Returns: EmailDlpRule
Example:
resource = session.zia.EmailDlpRule()
resource.action = "value"
resource.auditor = {"association_time": 3600, "deleted": True, "extensions": {"key1": "value", "key2": "value"}, "external_id": "resource-id"}
resource.content_locations = ["value"]
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a EmailDlpRule by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.EmailDlpRule(id="your-resource-id")
resource.delete()
list_email_dlp_policy_actions()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
tenant_ids | integer | Yes | - |
Returns: EmailDlpPolicyActionEnumsRecord
Example:
resource = session.zia.EmailDlpRule()
result = resource.list_email_dlp_policy_actions(tenant_ids=3600)
print(result)
load()
Fetches an existing EmailDlpRule by id. Only the id identifier is required; load() takes no other arguments.
Returns: EmailDlpRule
Example:
resource = session.zia.EmailDlpRule(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing EmailDlpRule. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
action | string | No | - |
auditor | EntityReference | No | - |
content_locations | ContentLocationsEnumCollection | No | - |
custom_header | string | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dlp_engines | EntityReferenceWrapperCollection | No | - |
email_recipient_profiles | EntityReferenceWrapperCollection | No | - |
email_tenants | EntityReferenceWrapperCollection | No | - |
excluded_departments | EntityReferenceWrapperCollection | No | - |
excluded_groups | EntityReferenceWrapperCollection | No | - |
excluded_users | EntityReferenceWrapperCollection | No | - |
external_auditor_email | string | No | - |
file_type_categories | FileTypeCategoryWrapperCollection | No | - |
file_types | stringCollection | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | Yes | - |
included_domain_profiles | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
min_size | integer | No | - |
name | string | No | - |
notification_template | EntityReference | No | - |
order | integer | No | - |
parent_rule | integer | No | - |
receiver | IncidentReceiverReference | No | - |
severity | string | No | - |
state | string | No | - |
sub_rules | EmailDlpRuleWrapperCollection | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
user_risk_score_levels | UserRiskScoreLevelsEnumCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
without_content_inspection | boolean | No | - |
Returns: EmailDlpRule
Example:
resource = session.zia.EmailDlpRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
action | string | No | - |
auditor | EntityReference | No | - |
content_locations | ContentLocationsEnumCollection | No | - |
custom_header | string | No | - |
departments | EntityReferenceWrapperCollection | No | - |
description | string | No | - |
dlp_engines | EntityReferenceWrapperCollection | No | - |
email_recipient_profiles | EntityReferenceWrapperCollection | No | - |
email_tenants | EntityReferenceWrapperCollection | No | - |
excluded_departments | EntityReferenceWrapperCollection | No | - |
excluded_groups | EntityReferenceWrapperCollection | No | - |
excluded_users | EntityReferenceWrapperCollection | No | - |
external_auditor_email | string | No | - |
file_type_categories | FileTypeCategoryWrapperCollection | No | - |
file_types | stringCollection | No | - |
groups | EntityReferenceWrapperCollection | No | - |
id | integer | No | - |
included_domain_profiles | EntityReferenceWrapperCollection | No | - |
labels | EntityReferenceWrapperCollection | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
min_size | integer | No | - |
name | string | No | - |
notification_template | EntityReference | No | - |
order | integer | No | - |
parent_rule | integer | No | - |
receiver | IncidentReceiverReference | No | - |
severity | string | No | - |
state | string | No | - |
sub_rules | EmailDlpRuleWrapperCollection | No | - |
template_synced_rule_flag | string | No | - |
time_windows | EntityReferenceWrapperCollection | No | - |
user_risk_score_levels | UserRiskScoreLevelsEnumCollection | No | - |
users | EntityReferenceWrapperCollection | No | - |
without_content_inspection | boolean | No | - |
Related
- EmailDlpRule - Data structure definition
- Logging guide - enable verbose logs while debugging this resource