zscaler.ziacloud.zia_authentication_settings_info module – Retrieves the organization’s default authentication settings information

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_authentication_settings_info.

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves the organization’s default authentication settings information

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 the organization's default authentication settings information
  zscaler.ziacloud.zia_authentication_settings_info:
    provider: '{{ provider }}'

Return Values

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

Key

Description

auth

list / elements=dictionary

A list of rule labels fetched based on the given criteria.

Returned: always

auth_custom_frequency

integer

How frequently users are required to authenticate e.g., cookie expiration duration.

Returned: always

Sample: 80

auth_frequency

string

How frequently users are required to authenticate e.g., cookie expiration duration.

Returned: always

Sample: "DAILY_COOKIE"

auto_provision

boolean

Enables SAML Auto-Provisioning.

Returned: always

Sample: false

directory_sync_migrate_to_scim_enabled

boolean

Enables migration to SCIM by disabling legacy sync.

Returned: always

Sample: false

kerberos_enabled

boolean

Whether or not to authenticate users using Kerberos.

Returned: always

Sample: false

kerberos_pwd

string

Can only be set through the generate KerberosPassword

Returned: always

Sample: "None"

last_sync_end_time

integer

Epoch timestamp representing end of last LDAP sync.

Returned: always

Sample: 587556687

last_sync_start_time

integer

Epoch timestamp representing start of last LDAP sync.

Returned: always

Sample: 587556687

mobile_admin_saml_idp_enabled

boolean

Indicates use of Mobile Admin as an IdP.

Returned: always

Sample: false

one_time_auth

string

The name of the rule label.

Returned: always

Sample: "OTP_DISABLED"

org_auth_type

string

The unique identifier for the rule label.

Returned: always

Sample: "ANY"

password_expiry

string

Password expiration required for form-based authentication of hosted DB users.

Returned: always

Sample: "SIX_MONTHS"

password_strength

string

Password strength for form-based authentication.

Returned: always

Sample: "STRONG"

saml_enabled

boolean

Whether or not to authenticate users using SAML Single Sign-On.

Returned: always

Sample: false

Authors

  • William Guilherme (@willguibr)