zscaler.zpacloud.zpa_scim_attribute_header_info module – Retrieves scim attribute header from a given IDP

Note

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

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about scim attribute header from a given IDP

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

ID of the scim attribute.

idp_name

string / required

Name of the IDP, required when ID is not sepcified.

name

string

Name of the scim attribute.

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 Information About All SCIM Attribute of an IDP
  zscaler.zpacloud.zpa_scim_attribute_header_facts:
    provider: "{{ zpa_cloud }}"
    idp_name: IdP_Name

- name: Get Information About the SCIM Attribute by Name
  zscaler.zpacloud.zpa_scim_attribute_header_facts:
    provider: "{{ zpa_cloud }}"
    name: costCenter
    idp_name: IdP_Name

- name: Get Information About the SCIM Attribute by ID
  zscaler.zpacloud.zpa_scim_attribute_header_facts:
    provider: "{{ zpa_cloud }}"
    id: 216196257331285842
    idp_name: IdP_Name

Return Values

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

Key

Description

attributes

list / elements=dictionary

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

Returned: always

case_sensitive

boolean

Indicates whether the SCIM attribute is case-sensitive.

Returned: always

Sample: false

creation_time

string

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

Returned: always

Sample: "1651557392"

data_type

string

The data type of the SCIM attribute.

Returned: always

Sample: "String"

delta

string

The delta identifier for the SCIM attribute, used for tracking changes.

Returned: always

Sample: "1776f53db627260cddebc5ca748a0982"

id

string

The unique identifier of the SCIM attribute.

Returned: always

Sample: "123456789"

idp_id

string

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

Returned: always

Sample: "123456789"

modified_by

string

The ID of the user who last modified the SCIM attribute.

Returned: always

Sample: "123456789"

multivalued

boolean

Indicates whether the SCIM attribute is multivalued.

Returned: always

Sample: false

mutability

string

The mutability of the SCIM attribute (e.g., readWrite, immutable).

Returned: always

Sample: "readWrite"

name

string

The name of the SCIM attribute.

Returned: always

Sample: "costCenter"

required

boolean

Indicates whether the SCIM attribute is required.

Returned: always

Sample: false

returned

string

Indicates when the SCIM attribute is returned in a response (e.g., always, default).

Returned: always

Sample: "default"

schema_u_r_i

string

The schema URI associated with the SCIM attribute.

Returned: always

Sample: "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"

uniqueness

boolean

Indicates whether the SCIM attribute is unique.

Returned: always

Sample: false

Authors

  • William Guilherme (@willguibr)