zscaler.ziacloud.zia_casb_tenant_info module – Gets information about CASB SaaS application tenants

Note

This module is part of the zscaler.ziacloud collection (version 2.2.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_casb_tenant_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets SaaS Security API tenants (cloud app tenants).

  • Retrieves a specific tenant by tenant_id or tenant_name.

  • Supports optional filters for active tenants, deleted tenants, app type, etc.

Requirements

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

Parameters

Parameter

Comments

active_only

boolean

Return only active tenants.

Choices:

  • false

  • true

api_key

string

A string that contains the obfuscated API key.

app

string

Filter tenants by sanctioned SaaS application (e.g., BOX, DROPBOX).

app_type

string

Filter tenants by application type.

Choices:

  • "ANY"

  • "FILE"

  • "EMAIL"

  • "CRM"

  • "ITSM"

  • "COLLAB"

  • "REPO"

  • "STORAGE"

  • "TP_APP"

  • "GENAI"

  • "MISC"

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

filter_by_feature

list / elements=string

Filter tenants by supported features.

include_bucket_ready_s3_tenants

boolean

Include S3 tenants ready for bucket creation.

Choices:

  • false

  • true

include_deleted

boolean

Include deleted tenants in the results.

Choices:

  • false

  • true

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

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.

scan_config_tenants_only

boolean

Return only tenants with scan config.

Choices:

  • false

  • true

tenant_id

integer

The unique identifier for the CASB tenant.

tenant_name

string

The name of the CASB tenant.

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: Get all CASB tenants
  zscaler.ziacloud.zia_casb_tenant_info:
    provider: '{{ provider }}'

- name: Get a CASB tenant by ID
  zscaler.ziacloud.zia_casb_tenant_info:
    provider: '{{ provider }}'
    tenant_id: 15881081

- name: Get a CASB tenant by name
  zscaler.ziacloud.zia_casb_tenant_info:
    provider: '{{ provider }}'
    tenant_name: "My Tenant"

- name: Get active tenants for BOX app
  zscaler.ziacloud.zia_casb_tenant_info:
    provider: '{{ provider }}'
    active_only: true
    app: BOX

Return Values

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

Key

Description

tenants

list / elements=dictionary

A list of CASB tenants fetched based on the given criteria.

Returned: always

enterprise_tenant_id

string

Enterprise tenant identifier.

Returned: when available

features_supported

list / elements=string

List of supported features.

Returned: when available

last_tenant_validation_time

integer

Last validation timestamp.

Returned: when available

modified_time

integer

Last modified timestamp.

Returned: when available

re_auth

boolean

Whether re-authentication is required.

Returned: when available

saas_application

string

The SaaS application (e.g., BOX, DROPBOX).

Returned: when available

status

list / elements=string

Tenant status list.

Returned: when available

tenant_deleted

boolean

Whether the tenant has been deleted.

Returned: when available

tenant_id

integer

The unique identifier for the CASB tenant.

Returned: always

tenant_name

string

The name of the tenant.

Returned: always

tenant_webhook_enabled

boolean

Whether webhook is enabled.

Returned: when available

zscaler_app_tenant_id

list / elements=string

Zscaler app tenant ID reference.

Returned: when available

Authors

  • William Guilherme (@willguibr)