profile
Overview
Name | profile |
Type | Resource |
Id | linode.profile.profile |
Fields
Name | Datatype | Description |
---|---|---|
ip_whitelist_enabled | 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. |
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. |
lish_auth_method | string | 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. |
verified_phone_number | string | 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. |
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. |
uid | integer | Your unique ID in our system. This value will never change, and can safely be used to identify your User. |
email_notifications | boolean | If true, you will receive email notifications about account activity. If false, you may still receive business-critical communications through email. |
username | string | Your username, used for logging in to our system. |
authentication_type | string | 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. |
authorized_keys | 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 | Your email address. This address will be used for communication with Linode as necessary. |
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. |
two_factor_auth | boolean | If true, logins from untrusted computers will require Two Factor Authentication. See /profile/tfa-enable to enable Two Factor Authentication. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
getProfile | SELECT | 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. | |
_getProfile | EXEC | 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. | |
updateProfile | EXEC | Update information in your Profile. This endpoint requires the "account:read_write" OAuth Scope. |