zscaler.zpacloud.zpa_scim_group_info module – Retrieves scim group information from a given IDP

Note

This module is part of the zscaler.zpacloud collection (version 2.0.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_scim_group_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about scim group(s) from a given IDP

Requirements

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

Parameters

Parameter

Comments

all_entries

boolean

Return all SCIM groups (including the deleted ones) if set to true.

Choices:

  • false

  • true

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.

end_time

string

The end of a time range for requesting last updated data (modified_time) for the SCIM group.

This requires setting the startTime parameter as well.

id

string

ID of the scim group.

idp_group_id

string

The unique identifier of the SCIM group.

idp_name

string / required

Name of the IDP.

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.

name

string

Name of the scim group.

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.

scim_user_id

string

The unique identifier for the SCIM user.

scim_user_name

string

The name of the SCIM user.

sort_by

string

Specifies the field name to sort the results.

The supported Sort fields are id, name, creation_time, and modified_time.

If not provided, the results are sorted by the modifiedTime field.

sort_order

string

Sort the last updated time (modified_time) by ascending (ASC) or descending (DSC) order

Choices:

  • "ASC"

  • "DSC"

start_time

string

The start of a time range for requesting last updated data (modified_time) for the SCIM group.

This requires setting the endTime parameter as well.

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 Information About All SCIM Groups from an IdP
  zscaler.zpacloud.zpa_scim_group_info:
    provider: "{{ zpa_cloud }}"
    idp_name: "IdP_Name"

- name: Get Information About a SCIM Group by ID
  zscaler.zpacloud.zpa_scim_group_info:
    provider: "{{ zpa_cloud }}"
    id: 216196257331285827
    idp_name: "IdP_Name"

- name: Get Information About a SCIM Group by Name
  zscaler.zpacloud.zpa_scim_group_info:
    provider: "{{ zpa_cloud }}"
    name: "Finance"
    idp_name: "IdP_Name"

Return Values

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

Key

Description

groups

list / elements=dictionary

Details of the SCIM groups retrieved from the specified Identity Provider (IdP).

Returned: always

creation_time

integer

The time when the SCIM group was created, in epoch format.

Returned: always

Sample: 1651557507

id

integer

The unique identifier of the SCIM group.

Returned: always

Sample: 645699

idp_group_id

string

The group ID in the IdP system, if available.

Returned: when available

idp_id

integer

The unique identifier of the associated Identity Provider (IdP).

Returned: always

Sample: 123456789

internal_id

string

The internal identifier of the SCIM group.

Returned: always

Sample: "645699"

modified_time

integer

The time when the SCIM group was last modified, in epoch format.

Returned: always

Sample: 1651557507

name

string

The name of the SCIM group.

Returned: always

Sample: "Engineering"

Authors

  • William Guilherme (@willguibr)