zscaler.zpacloud.zpa_managed_browser_profile_info module – Retrieves information about a Managed Browser Profile.

Note

This module is part of the zscaler.zpacloud collection (version 2.1.0).

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.zpacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.zpacloud.zpa_managed_browser_profile_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about a Managed Browser Profile.

  • Managed Browser Profiles configure browser access policies and posture requirements.

Requirements

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

Parameters

Parameter

Comments

client_id

string

The client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Used for OneAPI client authentication when use_legacy_client=false.

id

string

ID of the Managed Browser Profile.

microtenant_id

string

The unique identifier of the Microtenant for the ZPA tenant.

name

string

Name of the Managed Browser Profile.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

provider

dictionary

A dict containing authentication credentials.

client_id

string

The client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Used for OneAPI client authentication when use_legacy_client=false.

microtenant_id

string

The ZPA Microtenant ID found in the Administration Company menu in the ZPA console.

Used for OneAPI client authentication when use_legacy_client=false.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

The ZPA Microtenant ID found in the Administration Company menu in the ZPA console.

Used for legacy client authentication when use_legacy_client=true.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

The ZPA Microtenant ID found in the Administration Company menu in the ZPA console.

Used for legacy client authentication when use_legacy_client=true.

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Detail Information of All Managed Browser Profiles
  zscaler.zpacloud.zpa_managed_browser_profile_info:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a Managed Browser Profile by Name
  zscaler.zpacloud.zpa_managed_browser_profile_info:
    provider: "{{ zpa_cloud }}"
    name: "Chrome_Profile"

- name: Get Details of a Managed Browser Profile by ID
  zscaler.zpacloud.zpa_managed_browser_profile_info:
    provider: "{{ zpa_cloud }}"
    id: "216196257331291969"

Return Values

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

Key

Description

profiles

list / elements=dictionary

A list of dictionaries containing details about the Managed Browser Profiles.

Returned: always

browser_type

string

The type of browser associated with the profile.

Returned: success

Sample: "CHROME"

chrome_posture_profile

list / elements=dictionary

Chrome posture profile configuration.

Returned: success

browser_type

string

The browser type for the posture profile.

Returned: success

Sample: "CHROME"

creation_time

string

The timestamp when the posture profile was created.

Returned: success

Sample: "1724111641"

crowd_strike_agent

boolean

Whether CrowdStrike agent is required.

Returned: success

Sample: false

id

string

The unique identifier of the Chrome posture profile.

Returned: success

Sample: "216199618143442001"

modified_by

string

The ID of the user who last modified the posture profile.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the posture profile was last modified.

Returned: success

Sample: "1724111641"

creation_time

string

The timestamp when the profile was created.

Returned: success

Sample: "1724111641"

customer_id

string

The customer ID associated with the profile.

Returned: success

Sample: "216199618143191041"

description

string

A brief description of the Managed Browser Profile.

Returned: success

Sample: "Chrome browser profile for corporate access"

id

string

The unique identifier of the Managed Browser Profile.

Returned: success

Sample: "216199618143442000"

microtenant_id

string

The unique identifier of the microtenant associated with the profile.

Returned: success

Sample: "216199618143191041"

microtenant_name

string

The name of the microtenant associated with the profile.

Returned: success

Sample: "Default"

modified_by

string

The ID of the user who last modified the profile.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the profile was last modified.

Returned: success

Sample: "1724111641"

name

string

The name of the Managed Browser Profile.

Returned: success

Sample: "Chrome_Profile"

Authors

  • William Guilherme (@willguibr)