zscaler.ziacloud.zia_user_management_info module – Gets a list of users

Note

This module is part of the zscaler.ziacloud 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.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_user_management_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of users

Requirements

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

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

id

integer

User ID.

name

string

User name. This appears when choosing users for policies.

password

string

A string that contains the password for the API admin.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gets a list of all users
  zscaler.ziacloud.zia_user_management_info:
    provider: '{{ provider }}'

- name: Gets a list of a single user
  zscaler.ziacloud.zia_user_management_info:
    provider: '{{ provider }}'
    name: "Adam Ashcroft"

Return Values

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

Key

Description

users

list / elements=dictionary

List of users retrieved by the module.

Returned: always

Sample: [{"admin_user": false, "deleted": false, "department": {"id": 45513014, "name": "Engineering"}, "email": "adam.ashcroft@bd-hashicorp.com", "groups": [], "id": 45513075, "is_non_editable": false, "name": "Adam Ashcroft"}]

admin_user

boolean

Flag indicating if the user has admin privileges.

Returned: success

Sample: false

deleted

boolean

Flag indicating if the user’s profile has been deleted.

Returned: success

Sample: false

department

dictionary

The department to which the user belongs.

Returned: success

id

integer

The unique identifier of the department.

Returned: success

Sample: 45513014

name

string

The name of the department.

Returned: success

Sample: "Engineering"

email

string

The email address of the user.

Returned: success

Sample: "adam.ashcroft@bd-hashicorp.com"

groups

list / elements=string

List of groups to which the user belongs.

Returned: success

Sample: []

id

integer

The unique identifier for the user.

Returned: success

Sample: 45513075

is_non_editable

boolean

Flag indicating if the user’s profile is non-editable.

Returned: success

Sample: false

name

string

The name of the user.

Returned: success

Sample: "Adam Ashcroft"

Authors

  • William Guilherme (@willguibr)