zscaler.zpacloud.zpa_pra_credential_controller_info module – Retrieves information about a PRA Credential.

Note

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

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

New in zscaler.zpacloud 1.1.0

Synopsis

  • This module will allow the retrieval of information about a PRA Credential.

Requirements

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

Parameters

Parameter

Comments

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

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

id

string

The unique identifier of the privileged credential

name

string

The name of the privileged credential

provider

dictionary

A dict object containing authentication details.

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

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

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Detail Information of All PRA Credentials
  zscaler.zpacloud.zpa_pra_credential_controller_info:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a PRA Credential by Name
  zscaler.zpacloud.zpa_pra_credential_controller_info:
    provider: "{{ zpa_cloud }}"
    name: "Example"

- name: Get Details of a PRA Credential by ID
  zscaler.zpacloud.zpa_pra_credential_controller_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

changed

boolean

Indicates if any changes were made.

Returned: always

Sample: false

creds

list / elements=dictionary

A list of dictionaries containing details about the specified PRA Credential(s).

Returned: always

creation_time

string

The timestamp when the PRA Credential was created.

Returned: success

Sample: "1724113778"

credential_type

string

The type of the PRA Credential.

Returned: success

Sample: "USERNAME_PASSWORD"

description

string

A description of the PRA Credential.

Returned: success

Sample: "credential01"

id

string

The unique identifier of the PRA Credential.

Returned: success

Sample: "8530"

last_credential_reset_time

string

The timestamp when the PRA Credential was last reset.

Returned: success

Sample: "1724113778"

microtenant_name

string

The name of the microtenant associated with the PRA Credential.

Returned: success

Sample: "Default"

modified_by

string

The ID of the user who last modified the PRA Credential.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the PRA Credential was last modified.

Returned: success

Sample: "1724113778"

name

string

The name of the PRA Credential.

Returned: success

Sample: "credential01"

user_domain

string

The user domain associated with the PRA Credential.

Returned: success

Sample: "acme.com"

user_name

string

The user name associated with the PRA Credential.

Returned: success

Sample: "jdoe"

failed

boolean

Indicates if the operation failed.

Returned: always

Sample: false

Authors

  • William Guilherme (@willguibr)