Users
This section details User-related Linode CLI commands.
list
Aliases: ls
Returns a paginated list of all users on your account.
Usage
The format accepted by this command.
linode-cli users list [-h] [--username username]
[--order-by {username}] [--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli users list
Filterable Attributes
Arguments used to define a filter for response entries.
Name |
Type |
Description |
|---|---|---|
--username |
str |
The User’s username. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
str |
example_user@linode.com |
The email address for the User. |
|
password_created |
str |
2018-01-01T01:01:01 |
The date and time when this User’s current password was created. |
restricted |
bool |
true |
If true, the User must be granted access to perform actions or access entities on this Account. |
ssh_keys |
[]str |
[“home-pc”, “laptop”] |
A list of SSH Key labels added by this User. |
tfa_enabled |
bool |
true |
A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. |
user_type |
str |
parent |
If the user belongs to a parent or child account relationship, this defines the user type in the respective account. |
username |
str |
example_user |
The User’s username. |
verified_phone_number |
str |
+5555555555 |
The phone number verified for this User Profile with the Verify a phone number operation. |
last_login
Name |
Type |
Example |
Description |
|---|---|---|---|
last_login.login_datetime |
str |
2018-01-01T01:01:01 |
The date and time of this User’s most recent login attempt. |
last_login.status |
str |
successful |
The result of the most recent login attempt for this User. |
view
Returns information about a single user on your account.
Usage
The format accepted by this command.
linode-cli users view [-h] [--username username]
[--order-by {username}] [--order {asc,desc}] username
Sample
Examples of how this command might be used.
linode-cli users view example_user
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
username |
str |
The username to look up. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
str |
example_user@linode.com |
The email address for the User. |
|
password_created |
str |
2018-01-01T01:01:01 |
The date and time when this User’s current password was created. |
restricted |
bool |
true |
If true, the User must be granted access to perform actions or access entities on this Account. |
ssh_keys |
[]str |
[“home-pc”, “laptop”] |
A list of SSH Key labels added by this User. |
tfa_enabled |
bool |
true |
A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. |
user_type |
str |
parent |
If the user belongs to a parent or child account relationship, this defines the user type in the respective account. |
username |
str |
example_user |
The User’s username. |
verified_phone_number |
str |
+5555555555 |
The phone number verified for this User Profile with the Verify a phone number operation. |
last_login
Name |
Type |
Example |
Description |
|---|---|---|---|
last_login.login_datetime |
str |
2018-01-01T01:01:01 |
The date and time of this User’s most recent login attempt. |
last_login.status |
str |
successful |
The result of the most recent login attempt for this User. |
create
Creates a user on your account.
Usage
The format accepted by this command.
linode-cli users create [-h] [--username username]
[--restricted restricted] [--email email]
Sample
Examples of how this command might be used.
linode-cli users create \
--username example_user \
--email example_user@linode.com \
--restricted true
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--email * |
str |
example_user@linode.com |
The email address for the User. |
--username * |
str |
example_user |
The User’s username. |
--restricted |
bool |
true |
If true, the User must be granted access to perform actions or access entities on this Account. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
str |
example_user@linode.com |
The email address for the User. |
|
password_created |
str |
2018-01-01T01:01:01 |
The date and time when this User’s current password was created. |
restricted |
bool |
true |
If true, the User must be granted access to perform actions or access entities on this Account. |
ssh_keys |
[]str |
[“home-pc”, “laptop”] |
A list of SSH Key labels added by this User. |
tfa_enabled |
bool |
true |
A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. |
username |
str |
example_user |
The User’s username. |
verified_phone_number |
str |
+5555555555 |
The phone number verified for this User Profile with the Verify a phone number operation. |
last_login
Name |
Type |
Example |
Description |
|---|---|---|---|
last_login.login_datetime |
str |
2018-01-01T01:01:01 |
The date and time of this User’s most recent login attempt. |
last_login.status |
str |
successful |
The result of the most recent login attempt for this User. |
update
Update information about a user on your account, including its restricted status.
Usage
The format accepted by this command.
linode-cli users update [-h] [--restricted restricted]
[--email email] [--username username] username
Sample
Examples of how this command might be used.
linode-cli users update example_user \
--username example_user \
--email example@linode.com \
--restricted true
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
username |
str |
The username to look up. |
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
str |
example_user@linode.com |
The email address for the User. |
|
--restricted |
bool |
true |
If true, the User must be granted access to perform actions or access entities on this Account. |
--username |
str |
example_user |
The User’s username. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
str |
example_user@linode.com |
The email address for the User. |
|
password_created |
str |
2018-01-01T01:01:01 |
The date and time when this User’s current password was created. |
restricted |
bool |
true |
If true, the User must be granted access to perform actions or access entities on this Account. |
ssh_keys |
[]str |
[“home-pc”, “laptop”] |
A list of SSH Key labels added by this User. |
tfa_enabled |
bool |
true |
A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. |
user_type |
str |
parent |
If the user belongs to a parent or child account relationship, this defines the user type in the respective account. |
username |
str |
example_user |
The User’s username. |
verified_phone_number |
str |
+5555555555 |
The phone number verified for this User Profile with the Verify a phone number operation. |
last_login
Name |
Type |
Example |
Description |
|---|---|---|---|
last_login.login_datetime |
str |
2018-01-01T01:01:01 |
The date and time of this User’s most recent login attempt. |
last_login.status |
str |
successful |
The result of the most recent login attempt for this User. |
delete
Aliases: rm
Deletes a user.
Usage
The format accepted by this command.
linode-cli users delete [-h] username
Sample
Examples of how this command might be used.
linode-cli users delete example_user
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
username |
str |
The username to look up. |