View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Profile

Profile View

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 endpoint is always accessible, no matter what OAuth scopes the acting token has.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/profile

Response Samples

{
  "email": "example-user@gmail.com",
  "username": "exampleUser",
  "restricted": "",
  "verified_phone_number": "+5555555555",
  "uid": 1234,
  "timezone": "US/Eastern",
  "email_notifications": true,
  "referrals": {
    "code": "871be32f49c1411b14f29f618aaf0c14637fb8d3",
    "url": "https://www.linode.com/?r=871be32f49c1411b14f29f618aaf0c14637fb8d3",
    "total": 0,
    "completed": 0,
    "pending": 0,
    "credit": 0
  },
  "ip_whitelist_enabled": "",
  "lish_auth_method": "keys_only",
  "authorized_keys": [],
  "two_factor_auth": true,
  "authentication_type": "password"
}

Responses

200: Profile response.

email
string <email>

Your email address. This address will be used for communication with Linode as necessary.

username
string

Your username, used for logging in to our system.

restricted
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, see /profile/grants.

verified_phone_number
Nullable
string <phone>

The phone number verified for this Profile with the Phone Number Verify (POST /profile/phone-number/verify) command.

null if this Profile has no verified phone number.

uid
integer

Your unique ID in our system. This value will never change, and can safely be used to identify your User.

timezone
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.

email_notifications
boolean

If true, you will receive email notifications about account activity. If false, you may still receive business-critical communications through email.

referrals
object

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.

code
string

Your referral code. If others use this when signing up for Linode, you will receive account credit.

url
string

Your referral url, used to direct others to sign up for Linode with your referral code.

total
integer

The number of users who have signed up with your referral code.

completed
integer

The number of completed signups with your referral code.

pending
integer

The number of pending signups with your referral code. You will not receive credit for these signups until they are completed.

credit
integer

The amount of account credit in US Dollars issued to you through the referral program.

ip_whitelist_enabled
boolean
Deprecated

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.

lish_auth_method
string
Enum: "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 View Profile endpoint.
authorized_keys
Nullable
array of objects

The list of SSH Keys authorized to use Lish for your User. This value is ignored if lish_auth_method is "disabled."

two_factor_auth
boolean

If true, logins from untrusted computers will require Two Factor Authentication. See /profile/tfa-enable to enable Two Factor Authentication.

authentication_type
string
Enum: "password""github"

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 indentity 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.

default: Error

errors
array of objects
reason
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.

field
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.

Profile Update

put
https://api.linode.com/v4/profile

Update information in your Profile. This endpoint requires the "account:read_write" OAuth Scope.

Request Body Schema

authorized_keys
Nullable
array

The list of SSH Keys authorized to use Lish for your User. This value is ignored if lish_auth_method is "disabled."

email
string <email>

Your email address. This address will be used for communication with Linode as necessary.

email_notifications
boolean

If true, you will receive email notifications about account activity. If false, you may still receive business-critical communications through email.

ip_whitelist_enabled
boolean
Deprecated

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.

lish_auth_method
string
Enum: "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 View Profile endpoint.
restricted
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, see /profile/grants.

timezone
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.

two_factor_auth
boolean

If true, logins from untrusted computers will require Two Factor Authentication. See /profile/tfa-enable to enable Two Factor Authentication.

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X PUT -d '{
      "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
    }' \
    https://api.linode.com/v4/profile

Response Samples

{
  "email": "example-user@gmail.com",
  "username": "exampleUser",
  "restricted": "",
  "verified_phone_number": "+5555555555",
  "uid": 1234,
  "timezone": "US/Eastern",
  "email_notifications": true,
  "referrals": {
    "code": "871be32f49c1411b14f29f618aaf0c14637fb8d3",
    "url": "https://www.linode.com/?r=871be32f49c1411b14f29f618aaf0c14637fb8d3",
    "total": 0,
    "completed": 0,
    "pending": 0,
    "credit": 0
  },
  "ip_whitelist_enabled": "",
  "lish_auth_method": "keys_only",
  "authorized_keys": [],
  "two_factor_auth": true,
  "authentication_type": "password"
}

Responses

200: Profile updated successfully.

email
string <email>

Your email address. This address will be used for communication with Linode as necessary.

username
string

Your username, used for logging in to our system.

restricted
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, see /profile/grants.

verified_phone_number
Nullable
string <phone>

The phone number verified for this Profile with the Phone Number Verify (POST /profile/phone-number/verify) command.

null if this Profile has no verified phone number.

uid
integer

Your unique ID in our system. This value will never change, and can safely be used to identify your User.

timezone
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.

email_notifications
boolean

If true, you will receive email notifications about account activity. If false, you may still receive business-critical communications through email.

referrals
object

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.

code
string

Your referral code. If others use this when signing up for Linode, you will receive account credit.

url
string

Your referral url, used to direct others to sign up for Linode with your referral code.

total
integer

The number of users who have signed up with your referral code.

completed
integer

The number of completed signups with your referral code.

pending
integer

The number of pending signups with your referral code. You will not receive credit for these signups until they are completed.

credit
integer

The amount of account credit in US Dollars issued to you through the referral program.

ip_whitelist_enabled
boolean
Deprecated

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.

lish_auth_method
string
Enum: "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 View Profile endpoint.
authorized_keys
Nullable
array of objects

The list of SSH Keys authorized to use Lish for your User. This value is ignored if lish_auth_method is "disabled."

two_factor_auth
boolean

If true, logins from untrusted computers will require Two Factor Authentication. See /profile/tfa-enable to enable Two Factor Authentication.

authentication_type
string
Enum: "password""github"

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 indentity 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.

default: Error

errors
array of objects
reason
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.

field
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.