List users

get https://api.linode.com/{apiVersion}/account/users

Returns a paginated list of all users on your account.

📘
This operation can only be accessed by account users with unrestricted access.

A user can access all or part of an account based on their access status and grants:

Unrestricted access. These users can access everything on an account.
Restricted access. These users can only access entities or perform actions they've been given specific grants to.

linode-cli users list


Learn more...

account:read_only


Learn more...

Responses

Response body

object

data

array of objects

data

object

string

This user's email address. Akamai uses this address for account management communications.

last_login

object | null

Read-only Details on this user's last login attempt. Returned as null if this user hasn't attempted a login since it was created. You can run the List user logins operation for additional login information.

password_created

date-time | null

Read-only When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the Reset Password webpage. Returned as null if this user doesn't have a password set.

restricted

boolean

If true, this user needs specific access granted to perform actions or access entities on your account. Run List a user's grants for details on how to configure grants for a restricted user.

ssh_keys

array of strings

Read-only A list of the labels for SSH keys added by this user. Users can add keys with the Add an SSH key operation. These keys are deployed when this user is included in the authorized_users field of the following requests:

ssh_keys

tfa_enabled

boolean

Read-only Whether this user has Two Factor Authentication (TFA) enabled. Run the Create a two factor secret operation to enable TFA.

username

string

length between 3 and 32

Filterable The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.

verified_phone_number

string | null

Read-only The verified phone number for this user profile. Returned as null if the user doesn't have a verified phone number.

user_type

string

Read-only If the user belongs to a parent or child account relationship, this defines the user type in the respective account. Possible values include:

parent. This is a user in an Akamai partner account. Akamai partners have a contractural relationship with their end customers, to sell Akamai services. This user can either have full access (a parent account admin user) or limited access. Limited users don't have access to manage child accounts, but they can be granted this access by an admin user.
child. This is an Akamai partner's end customer user, in a child account. A child user can have either full or limited access. Full access lets the user manage other child users and the proxy user in a child account.
proxy. This is a user on a child account that gives parent account users access to that child account. A parent account user with the child_account_access grant can Create a proxy user token from the parent account. The parent user can use this token to run API operations from the child account, as if they were a child user.
default. This applies to all regular, non-parent-child account users.

parent child proxy default

page

integer

Read-only The current page.

pages

integer

Read-only The total number of pages.

results

integer

Read-only The total number of results.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.linode.com/v4/account/users?page=1&page_size=100' \
3
     --header 'accept: application/json'


xxxxxxxxxx
24
 
1
{
2
  "data": [
3
    {
4
      "email": "jperez@linode.com",
5
      "last_login": {
6
        "login_datetime": "2018-01-01T01:01:01",
7
        "status": "successful"
8
      },
9
      "password_created": "2018-01-01T01:01:01",
10
      "restricted": true,
11
      "ssh_keys": [
12
        "home-pc",
13
        "laptop"
14
      ],
15
      "tfa_enabled": true,
16
      "user_type": "parent",
17
      "username": "jsmith",
18
      "verified_phone_number": "+5555555555"
19
    }
20
  ],
21
  "page": 1,
22
  "pages": 1,
23
  "results": 1
24
}

200A paginated list of users.

defaultSee Errors for the range of possible error response codes.