zscaler.ziacloud.zia_end_user_notification_info 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_info.

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.

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"

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.

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

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.

Notes

Note

  • Check mode is not supported.

Examples

- name: Retrieves browser-based end user notification
  zscaler.ziacloud.zia_end_user_notification_info:
    provider: '{{ provider }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

notification

dictionary

Browser-based End User Notification (EUN) configuration settings.

Returned: always

aup_day_offset

integer

Specifies which day of the week or month the AUP is shown when aupFrequency is set. Valid range is 1 to 31.

Returned: success

Sample: 0

aup_frequency

string

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

Returned: success

Sample: "NEVER"

aup_message

string

The acceptable use statement that is shown in the AUP.

Returned: success

Sample: ""

caution_again_after

integer

Time interval at which caution notification is shown for restricted sites.

Returned: success

Sample: 300

caution_custom_text

string

Custom message that appears in the caution notification.

Returned: success

Sample: "Proceeding to visit the site may violate your company policy."

caution_per_domain

boolean

Whether the caution notification is shown per domain.

Returned: success

Sample: false

custom_text

string

Custom text shown in the End User Notification.

Returned: success

Sample: "Website blocked"

boolean

Whether the organization’s logo appears in the notification.

Returned: success

Sample: true

display_comp_name

boolean

Whether the organization’s name appears in the notification.

Returned: success

Sample: true

display_reason

boolean

Whether the reason for blocking or cautioning is displayed in the notification.

Returned: success

Sample: true

idp_proxy_notification_text

string

Message that appears in the IdP Proxy notification.

Returned: success

Sample: ""

notification_type

string

Type of End User Notification, either DEFAULT or CUSTOM.

Returned: success

Sample: "DEFAULT"

string

Link to the organization’s policy page.

Returned: success

Sample: "http://44772833.zscalertwo.net/policy.html"

quarantine_custom_notification_text

string

Message shown during file quarantine analysis.

Returned: success

Sample: "We are checking this file for a potential security risk. ..."

security_review_enabled

boolean

Whether the Security Violation notification is enabled.

Returned: success

Sample: false

security_review_submit_to_security_cloud

boolean

Whether Security Violation review requests are submitted to Security Cloud.

Returned: success

Sample: false

security_review_text

string

Message that appears for Security Violation notifications.

Returned: success

Sample: "Click to request security review."

support_email

string

IT support email address displayed in the notification.

Returned: success

Sample: "support@44772833.zscalertwo.net"

support_phone

string

IT support phone number displayed in the notification.

Returned: success

Sample: "+91-9000000000"

url_cat_review_enabled

boolean

Whether the URL Categorization Review notification is enabled.

Returned: success

Sample: false

url_cat_review_submit_to_security_cloud

boolean

Whether URL Categorization Review requests are submitted to Security Cloud.

Returned: success

Sample: false

url_cat_review_text

string

Message that appears in the URL Categorization Review notification.

Returned: success

Sample: "If you believe you received this message in error, please click here to request a review of this site."

web_dlp_review_enabled

boolean

Whether the Web DLP Violation notification is enabled.

Returned: success

Sample: false

web_dlp_review_submit_to_security_cloud

boolean

Whether Web DLP Review requests are submitted to Security Cloud.

Returned: success

Sample: false

web_dlp_review_text

string

Message that appears in the Web DLP Violation notification.

Returned: success

Sample: "Click to request policy review."

Authors

  • William Guilherme (@willguibr)