Profile
v4.176.0 Get a profile GET
https://api.linode.com/v4/profile
Returns information about the current User. This can be used to see who is acting in applications where more than one token is managed. For example, in third-party OAuth applications.
This operation is always accessible, no matter what OAuth scopes the acting token has.
Authorizations Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"authentication_type" : "password" ,
"authorized_keys" : [
null
],
"email" : "example-user@gmail.com" ,
"email_notifications" : true ,
"ip_whitelist_enabled" : false ,
"lish_auth_method" : "keys_only" ,
"referrals" : {
"code" : "871be32f49c1411b14f29f618aaf0c14637fb8d3" ,
"completed" : 0 ,
"credit" : 0 ,
"pending" : 0 ,
"total" : 0 ,
"url" : "https://www.linode.com/?r=871be32f49c1411b14f29f618aaf0c14637fb8d3"
},
"restricted" : false ,
"timezone" : "US/Eastern" ,
"two_factor_auth" : true ,
"uid" : 1234 ,
"username" : "exampleUser" ,
"verified_phone_number" : "+5555555555"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Profile response.
stringEnum:
password
github
Read-only This account’s Cloud Manager authentication type. Authentication types are chosen through Cloud Manager and authorized when logging into your account. These authentication types are either the user’s password (in conjunction with their username), or the name of their identity provider such as GitHub. For example, if a user:
Has never used Third-Party Authentication, their authentication type will be password. Is using Third-Party Authentication, their authentication type will be the name of their Identity Provider (eg. github). Has used Third-Party Authentication and has since revoked it, their authentication type will be password. Note: This functionality may not yet be available in Cloud Manager. See the Cloud Manager Changelog for the latest updates.
array
of strings
The list of SSH Keys authorized to use Lish for your User. This value is ignored
if lish_auth_method is “disabled.”
string<email>
Your email address. This address will be used for communication with Linode as necessary.
boolean
If true, you will receive email notifications about account activity. If false, you may
still receive business-critical communications through email.
boolean
If true, logins for your User will only be allowed from whitelisted IPs. This setting
is currently deprecated, and cannot be enabled. If you disable
this setting, you will not be able to re-enable it.
stringEnum:
password_keys
keys_only
disabled
The authentication methods that are allowed when connecting to the Linode Shell (Lish) .
keys_only is the most secure if you intend to use Lish.disabled is recommended if you do not intend to use Lish at all.If this account’s Cloud Manager authentication type is set to a Third-Party Authentication method, password_keys cannot be used as your Lish authentication method. To view this account’s Cloud Manager authentication_type field, send a request to the Get a profile operation. object
Read-only Information about your status in our referral program.
This information becomes accessible after this Profile’s Account has established at least $25.00 USD of total payments.
string
Read-only Your referral code. If others use this when signing up for Linode,
you will receive account credit.
integer
Read-only The number of completed signups with your referral code.
integer
Read-only The amount of account credit in US Dollars issued to you through
the referral program.
integer
Read-only The number of pending signups with your referral code. You
will not receive credit for these signups until they are
completed.
integer
Read-only The number of users who have signed up with your referral code.
string<url>
Read-only Your referral url, used to direct others to sign up for Linode
with your referral code.
boolean
If true, your User has restrictions on what can be accessed on your Account. To
get details on what entities/actions you can access/perform,
run List grants .
string
The timezone you prefer to see times in. This is not used by the API directly. It is
provided for the benefit of clients such as the Linode Cloud
Manager and other clients built on the API. All times returned
by the API are in UTC.
boolean
If true, logins from untrusted computers will require Two Factor Authentication. Run
Create a two factor secret
to enable Two Factor Authentication.
integer
Read-only Your unique ID in our system. This value will never change, and can
safely be used to identify your User.
string
Read-only Your username, used for logging in to our system.
verified_phone_number
Nullable
string<phone>
Read-only The phone number verified for this Profile with the Verify a phone number operation.
null if this Profile has no verified phone number.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
Update a profile PUT
https://api.linode.com/v4/profile
Update information in your Profile. This operation requires the “account:read_write” OAuth Scope.
Parent and child accounts
In a parent and child account environment, the following apply:
You can’t edit the email for a child account parent user (proxy user). This value is fixed and set when you provision this environment. Authorizations personalAccessToken oauth account:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"email": "example-user@gmail.com",
"timezone": "US/Eastern",
"email_notifications": true,
"lish_auth_method": "keys_only",
"authorized_keys": null,
"two_factor_auth": true,
"restricted": false
}' \
linode-cli profile update \
\
\
true \
\
true \
Request Body Schema array
of strings
The list of SSH Keys authorized to use Lish for your User. This value is ignored if
lish_auth_method is “disabled.”
string<email>
Your email address. This address will be used for communication with Linode as necessary.
boolean
If true, you will receive email notifications about account activity. If false, you may
still receive business-critical communications through email.
boolean
If true, logins for your User will only be allowed from whitelisted IPs. This setting is
currently deprecated, and cannot be enabled. If you disable this
setting, you will not be able to re-enable it.
stringEnum:
password_keys
keys_only
disabled
The authentication methods that are allowed when connecting to the Linode Shell (Lish) .
keys_only is the most secure if you intend to use Lish.disabled is recommended if you do not intend to use Lish at all.If this account’s Cloud Manager authentication type is set to a Third-Party Authentication method, password_keys cannot be used as your Lish authentication method. To view this account’s Cloud Manager authentication_type field, send a request to the Get a profile operation. boolean
If true, your User has restrictions on what can be accessed on your Account. To get details
on what entities/actions you can access/perform, run List grants .
string
The timezone you prefer to see times in. This is not used by the API directly. It is provided
for the benefit of clients such as the Linode Cloud Manager and
other clients built on the API. All times returned by the API
are in UTC.
boolean
If true, logins from untrusted computers will require Two Factor Authentication. Run
Create a two factor secret
to enable Two Factor Authentication.
Response Samples
200
default
{
"authentication_type" : "password" ,
"authorized_keys" : [
null
],
"email" : "example-user@gmail.com" ,
"email_notifications" : true ,
"ip_whitelist_enabled" : false ,
"lish_auth_method" : "keys_only" ,
"referrals" : {
"code" : "871be32f49c1411b14f29f618aaf0c14637fb8d3" ,
"completed" : 0 ,
"credit" : 0 ,
"pending" : 0 ,
"total" : 0 ,
"url" : "https://www.linode.com/?r=871be32f49c1411b14f29f618aaf0c14637fb8d3"
},
"restricted" : false ,
"timezone" : "US/Eastern" ,
"two_factor_auth" : true ,
"uid" : 1234 ,
"username" : "exampleUser" ,
"verified_phone_number" : "+5555555555"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Profile updated successfully.
stringEnum:
password
github
Read-only This account’s Cloud Manager authentication type. Authentication types are chosen through Cloud Manager and authorized when logging into your account. These authentication types are either the user’s password (in conjunction with their username), or the name of their identity provider such as GitHub. For example, if a user:
Has never used Third-Party Authentication, their authentication type will be password. Is using Third-Party Authentication, their authentication type will be the name of their Identity Provider (eg. github). Has used Third-Party Authentication and has since revoked it, their authentication type will be password. Note: This functionality may not yet be available in Cloud Manager. See the Cloud Manager Changelog for the latest updates.
array
of strings
The list of SSH Keys authorized to use Lish for your User. This value is ignored
if lish_auth_method is “disabled.”
string<email>
Your email address. This address will be used for communication with Linode as necessary.
boolean
If true, you will receive email notifications about account activity. If false, you may
still receive business-critical communications through email.
boolean
If true, logins for your User will only be allowed from whitelisted IPs. This setting
is currently deprecated, and cannot be enabled. If you disable
this setting, you will not be able to re-enable it.
stringEnum:
password_keys
keys_only
disabled
The authentication methods that are allowed when connecting to the Linode Shell (Lish) .
keys_only is the most secure if you intend to use Lish.disabled is recommended if you do not intend to use Lish at all.If this account’s Cloud Manager authentication type is set to a Third-Party Authentication method, password_keys cannot be used as your Lish authentication method. To view this account’s Cloud Manager authentication_type field, send a request to the Get a profile operation. object
Read-only Information about your status in our referral program.
This information becomes accessible after this Profile’s Account has established at least $25.00 USD of total payments.
string
Read-only Your referral code. If others use this when signing up for Linode,
you will receive account credit.
integer
Read-only The number of completed signups with your referral code.
integer
Read-only The amount of account credit in US Dollars issued to you through
the referral program.
integer
Read-only The number of pending signups with your referral code. You
will not receive credit for these signups until they are
completed.
integer
Read-only The number of users who have signed up with your referral code.
string<url>
Read-only Your referral url, used to direct others to sign up for Linode
with your referral code.
boolean
If true, your User has restrictions on what can be accessed on your Account. To
get details on what entities/actions you can access/perform,
run List grants .
string
The timezone you prefer to see times in. This is not used by the API directly. It is
provided for the benefit of clients such as the Linode Cloud
Manager and other clients built on the API. All times returned
by the API are in UTC.
boolean
If true, logins from untrusted computers will require Two Factor Authentication. Run
Create a two factor secret
to enable Two Factor Authentication.
integer
Read-only Your unique ID in our system. This value will never change, and can
safely be used to identify your User.
string
Read-only Your username, used for logging in to our system.
verified_phone_number
Nullable
string<phone>
Read-only The phone number verified for this Profile with the Verify a phone number operation.
null if this Profile has no verified phone number.
Error
array
of objects
string
The field in the request that caused this error. This may be a path,
separated by periods in the case of nested fields. In
some cases this may come back as “null” if the error is
not specific to any single element of the request.
string
What happened to cause this error. In most cases, this can be fixed
immediately by changing the data you sent in the request,
but in some cases you will be instructed to Open a support
ticket
or perform some other action before you can complete the
request successfully.
