Profile
This section details Profile-related Linode CLI commands.
view
Returns information about the current User.
Usage
The format accepted by this command.
linode-cli profile view [-h] [--order-by {}] [--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli profile view
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
authentication_type |
str |
password |
This account’s Cloud Manager authentication type. |
authorized_keys |
[]str |
N/A |
The list of SSH Keys authorized to use Lish for your User. |
str |
example-user@gmail.com |
Your email address. |
|
email_notifications |
bool |
true |
If true, you will receive email notifications about account activity. |
ip_whitelist_enabled |
bool |
N/A |
If true, logins for your User will only be allowed from whitelisted IPs. |
lish_auth_method |
str |
keys_only |
The authentication methods that are allowed when connecting to the Linode Shell (Lish). |
restricted |
bool |
N/A |
If true, your User has restrictions on what can be accessed on your Account. |
timezone |
str |
US/Eastern |
The timezone you prefer to see times in. |
two_factor_auth |
bool |
true |
If true, logins from untrusted computers will require Two Factor Authentication. |
uid |
int |
1234 |
Your unique ID in our system. |
username |
str |
exampleUser |
Your username, used for logging in to our system. |
verified_phone_number |
str |
+5555555555 |
The phone number verified for this Profile with the Verify a phone number operation. |
referrals
Name |
Type |
Example |
Description |
|---|---|---|---|
referrals.code |
str |
871be32f49c1…0c14637fb8d3 |
Your referral code. |
referrals.completed |
int |
N/A |
The number of completed signups with your referral code. |
referrals.credit |
int |
N/A |
The amount of account credit in US Dollars issued to you through the referral program. |
referrals.pending |
int |
N/A |
The number of pending signups with your referral code. |
referrals.total |
int |
N/A |
The number of users who have signed up with your referral code. |
referrals.url |
str |
https://www….0c14637fb8d3 |
Your referral url, used to direct others to sign up for Linode with your referral code. |
update
Update information in your Profile.
Usage
The format accepted by this command.
linode-cli profile update [-h]
[--two_factor_auth two_factor_auth]
[--authorized_keys authorized_keys]
[--ip_whitelist_enabled ip_whitelist_enabled] [--email email]
[--email_notifications email_notifications]
[--restricted restricted] [--timezone timezone]
[--lish_auth_method lish_auth_method]
Sample
Examples of how this command might be used.
linode-cli profile update \
--email example-user@gmail.com \
--timezone US/Eastern \
--email_notifications true \
--list_auth_method keys_only \
--two_factor_auth true \
--restricted false
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--authorized_keys |
[]str |
N/A |
(nullable) The list of SSH Keys authorized to use Lish for your User. |
str |
example-user@gmail.com |
Your email address. |
|
--email_notifications |
bool |
true |
If true, you will receive email notifications about account activity. |
--ip_whitelist_enabled |
bool |
N/A |
(deprecated) If true, logins for your User will only be allowed from whitelisted IPs. |
--lish_auth_method |
str |
keys_only |
The authentication methods that are allowed when connecting to the Linode Shell (Lish). |
--restricted |
bool |
N/A |
If true, your User has restrictions on what can be accessed on your Account. |
--timezone |
str |
US/Eastern |
The timezone you prefer to see times in. |
--two_factor_auth |
bool |
true |
If true, logins from untrusted computers will require Two Factor Authentication. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
authentication_type |
str |
password |
This account’s Cloud Manager authentication type. |
authorized_keys |
[]str |
N/A |
The list of SSH Keys authorized to use Lish for your User. |
str |
example-user@gmail.com |
Your email address. |
|
email_notifications |
bool |
true |
If true, you will receive email notifications about account activity. |
ip_whitelist_enabled |
bool |
N/A |
If true, logins for your User will only be allowed from whitelisted IPs. |
lish_auth_method |
str |
keys_only |
The authentication methods that are allowed when connecting to the Linode Shell (Lish). |
restricted |
bool |
N/A |
If true, your User has restrictions on what can be accessed on your Account. |
timezone |
str |
US/Eastern |
The timezone you prefer to see times in. |
two_factor_auth |
bool |
true |
If true, logins from untrusted computers will require Two Factor Authentication. |
uid |
int |
1234 |
Your unique ID in our system. |
username |
str |
exampleUser |
Your username, used for logging in to our system. |
verified_phone_number |
str |
+5555555555 |
The phone number verified for this Profile with the Verify a phone number operation. |
referrals
Name |
Type |
Example |
Description |
|---|---|---|---|
referrals.code |
str |
871be32f49c1…0c14637fb8d3 |
Your referral code. |
referrals.completed |
int |
N/A |
The number of completed signups with your referral code. |
referrals.credit |
int |
N/A |
The amount of account credit in US Dollars issued to you through the referral program. |
referrals.pending |
int |
N/A |
The number of pending signups with your referral code. |
referrals.total |
int |
N/A |
The number of users who have signed up with your referral code. |
referrals.url |
str |
https://www….0c14637fb8d3 |
Your referral url, used to direct others to sign up for Linode with your referral code. |
app-view
Returns information about a single app you’ve authorized to access your Account.
Usage
The format accepted by this command.
linode-cli profile app-view [-h] [--expiry expiry]
[--created created] [--label label]
[--order-by {expiry,created,label}] [--order {asc,desc}] appId
Sample
Examples of how this command might be used.
linode-cli profile app-view 1234
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
appId |
int |
The authorized app ID to manage. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T00:01:01 |
When this app was authorized. |
expiry |
str |
2018-01-15T00:01:01 |
When the app’s access to your account expires. |
id |
int |
123 |
This authorization’s ID, used for revoking access. |
label |
str |
example-app |
The name of the application you’ve authorized. |
scopes |
str |
linodes:read_only |
The OAuth scopes this app was authorized with. |
thumbnail_url |
str |
N/A |
The URL at which this app’s thumbnail may be accessed. |
website |
str |
example.org |
The website where you can get more information about this app. |
app-delete
Expires this app token.
Usage
The format accepted by this command.
linode-cli profile app-delete [-h] appId
Sample
Examples of how this command might be used.
linode-cli profile app-delete 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
appId |
int |
The authorized app ID to manage. |
apps-list
This is a collection of OAuth apps that you’ve given access to your Account, and includes the level of access granted.
Usage
The format accepted by this command.
linode-cli profile apps-list [-h] [--label label]
[--expiry expiry] [--created created]
[--order-by {label,expiry,created}] [--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli profile apps-list
Filterable Attributes
Arguments used to define a filter for response entries.
Name |
Type |
Description |
|---|---|---|
--created |
str |
When this app was authorized. |
--expiry |
str |
When the app’s access to your account expires. |
--label |
str |
The name of the application you’ve authorized. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T00:01:01 |
When this app was authorized. |
expiry |
str |
2018-01-15T00:01:01 |
When the app’s access to your account expires. |
id |
int |
123 |
This authorization’s ID, used for revoking access. |
label |
str |
example-app |
The name of the application you’ve authorized. |
scopes |
str |
linodes:read_only |
The OAuth scopes this app was authorized with. |
thumbnail_url |
str |
N/A |
The URL at which this app’s thumbnail may be accessed. |
website |
str |
example.org |
The website where you can get more information about this app. |
device-view
Returns a single active TrustedDevice for your User.
Usage
The format accepted by this command.
linode-cli profile device-view [-h] [--order-by {}]
[--order {asc,desc}] deviceId
Sample
Examples of how this command might be used.
linode-cli profile device-view 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
deviceId |
int |
The ID of the TrustedDevice. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T01:01:01 |
When this Remember Me session was started. |
expiry |
str |
2018-01-31T01:01:01 |
When this TrustedDevice session expires. |
id |
int |
123 |
The unique ID for this TrustedDevice. |
last_authenticated |
str |
2018-01-05T12:57:12 |
The last time this TrustedDevice was successfully used to authenticate to login.linode.com. |
last_remote_addr |
str |
203.0.113.1 |
The last IP Address to successfully authenticate with this TrustedDevice. |
user_agent |
str |
Mozilla/5.0 …/2.1.1337.36 |
The User Agent of the browser that created this TrustedDevice session. |
device-revoke
Revoke an active TrustedDevice for your User.
Usage
The format accepted by this command.
linode-cli profile device-revoke [-h] deviceId
Sample
Examples of how this command might be used.
linode-cli profile device-revoke 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
deviceId |
int |
The ID of the TrustedDevice. |
devices-list
Returns a paginated list of active TrustedDevices for your User.
Usage
The format accepted by this command.
linode-cli profile devices-list [-h] [--order-by {}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli profile devices-list
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T01:01:01 |
When this Remember Me session was started. |
expiry |
str |
2018-01-31T01:01:01 |
When this TrustedDevice session expires. |
id |
int |
123 |
The unique ID for this TrustedDevice. |
last_authenticated |
str |
2018-01-05T12:57:12 |
The last time this TrustedDevice was successfully used to authenticate to login.linode.com. |
last_remote_addr |
str |
203.0.113.1 |
The last IP Address to successfully authenticate with this TrustedDevice. |
user_agent |
str |
Mozilla/5.0 …/2.1.1337.36 |
The User Agent of the browser that created this TrustedDevice session. |
login-view
Returns a login object displaying information about a successful account login from this user.
Usage
The format accepted by this command.
linode-cli profile login-view [-h] [--order-by {}]
[--order {asc,desc}] loginId
Sample
Examples of how this command might be used.
linode-cli profile login-view 1234
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
loginId |
int |
The ID of the login object to access. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
datetime |
str |
2018-01-01T00:01:01 |
When the login was initiated. |
id |
int |
1234 |
The unique ID of this login object. |
ip |
str |
192.0.2.0 |
The remote IP address that requested the login. |
restricted |
bool |
true |
True if the User that attempted the login was a restricted User, false otherwise. |
status |
str |
successful |
Whether the login attempt succeeded or failed. |
username |
str |
example_user |
The username of the User that attempted the login. |
logins-list
Returns a collection of successful account logins from this user during the last 90 days.
Usage
The format accepted by this command.
linode-cli profile logins-list [-h] [--order-by {}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli profile logins-list
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
datetime |
str |
2018-01-01T00:01:01 |
When the login was initiated. |
id |
int |
1234 |
The unique ID of this login object. |
ip |
str |
192.0.2.0 |
The remote IP address that requested the login. |
restricted |
bool |
true |
True if the User that attempted the login was a restricted User, false otherwise. |
status |
str |
successful |
Whether the login attempt succeeded or failed. |
username |
str |
example_user |
The username of the User that attempted the login. |
tfa-confirm
Confirms that you can successfully generate Two Factor codes and enables TFA on your Account.
Usage
The format accepted by this command.
linode-cli profile tfa-confirm [-h] [--tfa_code tfa_code]
Sample
Examples of how this command might be used.
linode-cli profile tfa-confirm \
--tfa_code 213456
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--tfa_code |
str |
213456 |
The Two Factor code you generated with your Two Factor secret. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
scratch |
str |
sample two factor scratch |
A one-use code that can be used in place of your Two Factor code, in case you are unable to generate one. |
tfa-disable
Disables Two Factor Authentication for your User.
Usage
The format accepted by this command.
linode-cli profile tfa-disable [-h]
Sample
Examples of how this command might be used.
linode-cli profile tfa-disable
tfa-enable
Generates a Two Factor secret for your User.
Usage
The format accepted by this command.
linode-cli profile tfa-enable [-h]
Sample
Examples of how this command might be used.
linode-cli profile tfa-enable
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
expiry |
str |
2018-03-01T00:01:01 |
When this Two Factor secret expires. |
secret |
str |
5FXX6KLACOC33GTC |
Your Two Factor secret. |
token-view
Returns a single Personal Access Token.
Usage
The format accepted by this command.
linode-cli profile token-view [-h] [--created created]
[--label label] [--order-by {created,label}]
[--order {asc,desc}] tokenId
Sample
Examples of how this command might be used.
linode-cli profile token-view 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
tokenId |
int |
The ID of the token to access. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T00:01:01 |
The date and time this token was created. |
expiry |
str |
2018-01-01T13:46:32 |
When this token will expire. |
id |
int |
123 |
This token’s unique ID, which can be used to revoke it. |
label |
str |
linode-cli |
This token’s label. |
scopes |
str |
* |
The scopes this token was created with. |
token |
str |
abcdefghijklmnop |
The token used to access the API. |
token-create
Creates a Personal Access Token for your User.
Usage
The format accepted by this command.
linode-cli profile token-create [-h] [--expiry expiry]
[--scopes scopes] [--label label]
Sample
Examples of how this command might be used.
linode-cli profile token-create \
--scopes '*' \
--expiry '2018-01-01T13:46:32' \
--label linode-cli
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--expiry |
str |
N/A |
When this token should be valid until. |
--label |
str |
linode-cli |
This token’s label. |
--scopes |
str |
* |
The access scopes to grant to the created token. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T00:01:01 |
The date and time this token was created. |
expiry |
str |
2018-01-01T13:46:32 |
When this token will expire. |
id |
int |
123 |
This token’s unique ID, which can be used to revoke it. |
label |
str |
linode-cli |
This token’s label. |
scopes |
str |
* |
The scopes this token was created with. |
token |
str |
abcdefghijklmnop |
The token used to access the API. |
token-update
Updates a Personal Access Token.
Usage
The format accepted by this command.
linode-cli profile token-update [-h] [--label label] tokenId
Sample
Examples of how this command might be used.
linode-cli profile token-update 123 \
--label linode-cli
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
tokenId |
int |
The ID of the token to access. |
Arguments
Additional fields used to execute this request.
Name |
Type |
Example |
Description |
|---|---|---|---|
--label |
str |
linode-cli |
This token’s label. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T00:01:01 |
The date and time this token was created. |
expiry |
str |
2018-01-01T13:46:32 |
When this token will expire. |
id |
int |
123 |
This token’s unique ID, which can be used to revoke it. |
label |
str |
linode-cli |
This token’s label. |
scopes |
str |
* |
The scopes this token was created with. |
token |
str |
abcdefghijklmnop |
The token used to access the API. |
token-delete
Revokes a Personal Access Token.
Usage
The format accepted by this command.
linode-cli profile token-delete [-h] tokenId
Sample
Examples of how this command might be used.
linode-cli profile token-delete 123
Parameters
Positional parameters used to define the resource this command should target.
Name |
Type |
Description |
|---|---|---|
tokenId |
int |
The ID of the token to access. |
tokens-list
Returns a paginated list of Personal Access Tokens currently active for your User.
Usage
The format accepted by this command.
linode-cli profile tokens-list [-h] [--created created]
[--label label] [--order-by {created,label}]
[--order {asc,desc}]
Sample
Examples of how this command might be used.
linode-cli profile tokens-list
Filterable Attributes
Arguments used to define a filter for response entries.
Name |
Type |
Description |
|---|---|---|
--created |
str |
The date and time this token was created. |
--label |
str |
This token’s label. |
Result Attributes
The attributes returned by this command.
Name |
Type |
Example |
Description |
|---|---|---|---|
created |
str |
2018-01-01T00:01:01 |
The date and time this token was created. |
expiry |
str |
2018-01-01T13:46:32 |
When this token will expire. |
id |
int |
123 |
This token’s unique ID, which can be used to revoke it. |
label |
str |
linode-cli |
This token’s label. |
scopes |
str |
* |
The scopes this token was created with. |
token |
str |
abcdefghijklmnop |
The token used to access the API. |