Skip to main content

EndUserNotification

End User Notification resource for Internet Access.

Resource operations

This resource supports the following standard methods: load(), update(). 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 EndUserNotification
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",
)

# Call get_feature_enablement_status on EndUserNotification
resource = session.zia.EndUserNotification()
result = resource.get_feature_enablement_status(template_type="value")
print(result)

# Debug output shows HTTP request/response details

Actions​

get_feature_enablement_status()​

Parameters:

NameTypeRequiredDescription
template_typestringYes-
product_typestringNo-

Returns: EunTemplateFeatureEnablementStatus

Example:

resource = session.zia.EndUserNotification()
result = resource.get_feature_enablement_status(template_type="value")
print(result)

load()​

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

Returns: EndUserNotification

Example:

resource = session.zia.EndUserNotification()
resource.load()
print(resource.aup_frequency)

update()​

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

Properties for update:

NameTypeRequiredDescription
aup_custom_frequencyintegerNo-
aup_day_offsetintegerNo-
aup_frequencystringNo-
aup_messagestringNo-
caution_again_afterintegerNo-
caution_custom_textstringNo-
caution_per_domainbooleanNo-
custom_textstringNo-
display_comp_logobooleanNo-
display_comp_namebooleanNo-
display_reasonbooleanNo-
idp_proxy_notification_textstringNo-
notification_typestringNo-
org_policy_linkstringYes-
quarantine_custom_notification_textstringNo-
redirect_urlstringNo-
security_review_custom_locationstringNo-
security_review_enabledbooleanNo-
security_review_submit_to_security_cloudbooleanNo-
security_review_textstringNo-
support_emailstringNo-
support_phonestringNo-
url_cat_review_custom_locationstringNo-
url_cat_review_enabledbooleanNo-
url_cat_review_submit_to_security_cloudbooleanNo-
url_cat_review_textstringNo-
web_dlp_review_custom_locationstringNo-
web_dlp_review_enabledbooleanNo-
web_dlp_review_submit_to_security_cloudbooleanNo-
web_dlp_review_textstringNo-

Returns: EndUserNotification

Example:

resource = session.zia.EndUserNotification(id="your-resource-id")
resource.load()
resource.aup_frequency = "Updated value"
resource.update()

Attributes​

NameTypeRequiredDescription
aup_custom_frequencyintegerNo-
aup_day_offsetintegerNo-
aup_frequencystringNo-
aup_messagestringNo-
caution_again_afterintegerNo-
caution_custom_textstringNo-
caution_per_domainbooleanNo-
custom_textstringNo-
display_comp_logobooleanNo-
display_comp_namebooleanNo-
display_reasonbooleanNo-
idp_proxy_notification_textstringNo-
notification_typestringNo-
org_policy_linkstringYes-
quarantine_custom_notification_textstringNo-
redirect_urlstringNo-
security_review_custom_locationstringNo-
security_review_enabledbooleanNo-
security_review_submit_to_security_cloudbooleanNo-
security_review_textstringNo-
support_emailstringNo-
support_phonestringNo-
url_cat_review_custom_locationstringNo-
url_cat_review_enabledbooleanNo-
url_cat_review_submit_to_security_cloudbooleanNo-
url_cat_review_textstringNo-
web_dlp_review_custom_locationstringNo-
web_dlp_review_enabledbooleanNo-
web_dlp_review_submit_to_security_cloudbooleanNo-
web_dlp_review_textstringNo-