user_list.md

user_list

List and filter on Users.

• Minimum Required Fields
• Examples
• Parameters
• Return Values

Minimum Required Fields

Field	Type	Required	Description
api_token	str	Required	The Linode account personal access token. It is necessary to run the module. It can be exposed by the environment variable LINODE_API_TOKEN instead. See details in Usage.

Examples

- name: List all of the users for the current Linode Account
  linode.cloud.user_list: {}

Parameters

Field	Type	Required	Description
order	str	Optional	The order to list Users in. (Choices: desc, asc; Default: asc)
order_by	str	Optional	The attribute to order Users by.
filters (sub-options)	list	Optional	A list of filters to apply to the resulting Users.
count	int	Optional	The number of Users to return. If undefined, all results will be returned.

filters

Field	Type	Required	Description
name	str	Required	The name of the field to filter on. Valid filterable fields can be found here.
values	list	Required	A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

• users - The returned Users.

  • Sample Response:

    [
      {
        "email": "[email protected]",
        "restricted": true,
        "user_type": "default",
        "ssh_keys": [
          "home-pc",
          "laptop"
        ],
        "tfa_enabled": null,
        "username": "example_user"
      }
    ]

  • See the Linode API response documentation for a list of returned fields