zscaler.ziacloud.zia_end_user_notification module – Retrieves browser-based end user notification (EUN)

Note

This module is part of the zscaler.ziacloud collection (version 2.0.3).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install zscaler.ziacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.ziacloud.zia_end_user_notification.

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves browser-based end user notification (EUN) configuration details

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

aup_custom_frequency

integer

The custom frequency (in days) for showing the AUP to the end users. Valid range is 1 to 180.

aup_day_offset

integer

Specifies which day of the week or month the AUP is shown for users when aupFrequency is set.

Valid range is 1 to 31.

aup_frequency

string

The frequency at which the Acceptable Use Policy (AUP) is shown to the end users

Choices:

  • "NEVER"

  • "SESSION"

  • "DAILY"

  • "WEEKLY"

  • "ONLOGIN"

  • "CUSTOM"

  • "ON_DATE"

  • "ON_WEEKDAY"

aup_message

string

The acceptable use statement that is shown in the AUP

caution_again_after

integer

The time interval at which the caution notification is shown when users continue browsing a restricted site.

The recommended setting for complex websites, such as Social Networking sites, is at least 5 minutes.

caution_custom_text

string

The custom message that appears in the caution notification

caution_per_domain

boolean

Specifies whether to display the caution notification at a specific time interval for URLs in the Miscellaneous or Unknown category.

This option is applicable when a user browses a URL or a sub-domain of a URL in the Miscellaneous or Unknown category.

Choices:

  • false

  • true

client_id

string

The client ID for OAuth2 authentication.

client_secret

string

The client secret for OAuth2 authentication.

cloud

string

The Zscaler cloud name provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

custom_text

string

The custom text shown in the EUN

boolean

Indicates whether your organization’s logo appears in the EUN or not

Choices:

  • false

  • true

display_comp_name

boolean

Indicates whether the organization’s name appears in the EUN or not

Choices:

  • false

  • true

display_reason

boolean

Indicates whether or not the reason for cautioning or blocking access to a site

file, or application is shown when the respective notification is triggered

Choices:

  • false

  • true

idp_proxy_notification_text

string

The message that appears in the IdP Proxy notification

notification_type

string

The type of EUN as default or custom

Choices:

  • "DEFAULT"

  • "CUSTOM"

string

The URL of the organization’s policy page. This field is required for the default notification type.

password

string

A string that contains the password for the API admin.

private_key

string

The private key for JWT-based OAuth2 authentication.

provider

dictionary

A dict containing authentication credentials.

api_key

string

Obfuscated API key.

client_id

string

OAuth2 client ID.

client_secret

string

OAuth2 client secret.

cloud

string

Zscaler cloud name.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

password

string

Password for the API admin.

private_key

string

Private key for OAuth2 JWT.

sandbox_cloud

string

Sandbox Cloud environment.

sandbox_token

string

Sandbox API Key.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

Email ID of the API admin.

vanity_domain

string

Vanity domain for OAuth2.

quarantine_custom_notification_text

string

The message that appears in the quarantine notification

redirect_url

string

The redirect URL for the external site hosting the EUN specified when the custom notification type is selected

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

security_review_custom_location

string

A custom URL location where users’ review requests for possible misclassified URLs are sent

security_review_enabled

boolean

Indicates whether the Security Violation notification is enabled or disabled

Choices:

  • false

  • true

security_review_submit_to_security_cloud

boolean

Indicates whether users’ review requests for blocked URLs are submitted

To the Zscaler service i.e. Security Cloud or a custom location.

Choices:

  • false

  • true

security_review_text

string

The message that appears in the Security Violation notification

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

support_email

string

The email address for writing to IT Support

support_phone

string

The phone number for contacting IT Support

url_cat_review_custom_location

string

A custom URL location where users’ review requests for blocked URLs are sent

url_cat_review_enabled

boolean

Indicates whether the URL Categorization notification is enabled or disabled

Choices:

  • false

  • true

url_cat_review_submit_to_security_cloud

boolean

Indicates whether users’ review requests for possibly misclassified URLs are submitted

to the Zscaler service (i.e., Security Cloud) or a custom location.

A true value indicates that the request is sent to the Security cloud,

whereas a false value indicates that the request is sent to the specified custom location.

Choices:

  • false

  • true

url_cat_review_text

string

The message that appears in the URL Categorization notification

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

A string that contains the email ID of the API admin.

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

web_dlp_review_custom_location

string

A custom URL location where users’ review requests for the web DLP policy violation are sent

web_dlp_review_enabled

boolean

Indicates whether the Web DLP Violation notification is enabled or disabled

Choices:

  • false

  • true

web_dlp_review_submit_to_security_cloud

boolean

Indicates whether users’ review requests for web DLP policy violation are submitted to the

Zscaler service (i.e., Security Cloud) or a custom location.

A true value indicates that the request is sent to the Security cloud,

whereas a false value indicates that the request is sent to the specified custom location.

Choices:

  • false

  • true

web_dlp_review_text

string

The message that appears in the Web DLP Violation notification

Notes

Note

  • Check mode is not supported.

Examples

- name: Retrieves browser-based end user notification (EUN) configuration details
  zscaler.ziacloud.zia_end_user_notification:
    provider: '{{ provider }}'
    notification_type: "CUSTOM"
    aup_frequency: "NEVER"
    aup_day_offset: 0
    display_reason: false
    display_comp_name: false
    display_comp_logo: false
    url_cat_review_enabled: true
    url_cat_review_submit_to_security_cloud: true
    url_cat_review_text: "If you believe you received this message in error, click here."
    security_review_enabled: true
    security_review_submit_to_security_cloud: true
    security_review_text: "Click to request security review."
    web_dlp_review_enabled: true
    web_dlp_review_custom_location: "https://redirect.acme.com"
    web_dlp_review_text: "Click to request policy review."
    redirect_url: "https://redirect.acme.com"
    support_email: "support@000000.zscalerthree.net"
    support_phone: "+91-9000000000"
    org_policy_link: "http://000000.zscalerthree.net/policy.html"
    caution_again_after: 300
    caution_per_domain: true
    caution_custom_text: "This action may violate company policy."
    quarantine_custom_notification_text: "We are scanning this file for your safety. It may take up to 10 minutes."

Authors

  • William Guilherme (@willguibr)