user_list.md

user_list

List 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)
count	int	Optional	The number of results to return. If undefined, all results will be returned.

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