profile

Creates, updates, deletes, gets or lists a profile resource.

Overview

Name	profile
Type	Resource
Id	linode.profile.profile

Fields

The following fields are returned by SELECT queries:

get_profile

Profile response.

Name	Datatype	Description
authentication_type	string	Read-only This account's Cloud Manager authentication type. You choose an authentication type in Cloud Manager and Akamai authorizes it when you log into your account. Authentication types include your user's password (in conjunction with your username), or the name of your identity provider, such as GitHub. Here are some examples: - If a user has never used third-party authentication, the authentication type will be password. - If a user is using third-party authentication, the name of their identity provider is used for the authentication type, for example, github. - If a user has used third-party authentication and has since revoked it, the authentication type is password. (example: password)
authorized_keys	array	Your user can use these SSH Keys to access Lish. This value is ignored if lish_auth_method is disabled.
email	string (email)	Your email address. We use this address for Akamai Cloud Computing-related communication. (example: example-user@gmail.com)
email_notifications	boolean	When set to true, you will receive email notifications about account activity. When false, you may still receive business-critical communications through email.
ip_whitelist_enabled	boolean	When set to true, your user logins are only allowed from whitelisted IPs. This setting is deprecated, and can't be enabled. If you disable this setting, you won't be able to re-enable it.
lish_auth_method	string	The authentication methods that you can use when connecting to the Linode Shell (Lish). - keys_only is the most secure if you intend to use Lish. - disabled is recommended if you don't want to use Lish. - If this account's Cloud Manager authentication type is set to a third-party authentication method, you can't use password_keys as your Lish authentication method. Run the Get a profile operation to view your account's Cloud Manager authentication_type field. (example: keys_only)
referrals	object	Read-only Information about your status in our referral program. The API makes this information available after this profile's account has established at least $25.00 USD of total payments.
restricted	boolean	When set to true, there are restrictions on what your user can access on your account. Run List grants to get details on what entities and actions you can access and perform.
timezone	string	The time zone you want to display for your Linode assets. This API doesn't directly use this time zone. It's provided for the benefit of clients such as the Akamai Cloud Manager and other clients built on the API. All times returned by the API are in UTC. (example: US/Eastern)
two_factor_auth	boolean	When set to true, a login from an untrusted computer requires two-factor authentication. You also need to run Create a two factor secret to enable two-factor authentication.
uid	integer	Read-only Your unique ID in our system. This value will never change, and can safely be used to identify your user.
username	string	Read-only Your username, used for logging in to our system. (example: exampleUser)
verified_phone_number	string (phone)	Read-only The phone number verified for this profile with the Verify a phone number operation. Displayed as null if the profile doesn't have a verified phone number. (example: +5555555555)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_profile	select			Returns information about the current user. Use this to see who is acting in applications where more than one token is managed, such as a third-party OAuth application. > 📘 > > A third-party OAuth application accessing a profile with this operation has full access to all aspects of that profile. Learn more...
put_profile	replace			Update information in your profile. You need the account:read_write OAuth scope to use this operation. Parent and child accounts In a parent and child account environment, 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. Learn more... Learn more...
get_user_preferences	exec			View a list of user preferences tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. User preferences are available for each OAuth client registered to your account, and as such an account can have multiple user preferences. OAuth scopes. <br /> account:read_only<br /> Learn more...
put_user_preferences	exec			Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. An account may have multiple preferences. Preferences, and the pertaining request body, may contain any arbitrary JSON data that the user would like to store. OAuth scopes. <br /> account:read_write<br /> Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

SELECT examples

get_profile

Returns information about the current user. Use this to see who is acting in applications where more than one token is managed, such as a third-party OAuth application.

> 📘
>
> A third-party OAuth application accessing a profile with this operation has full access to all aspects of that profile.

Learn more...

SELECT
authentication_type,
authorized_keys,
email,
email_notifications,
ip_whitelist_enabled,
lish_auth_method,
referrals,
restricted,
timezone,
two_factor_auth,
uid,
username,
verified_phone_number
FROM linode.profile.profile;

REPLACE examples

put_profile

Update information in your profile. You need the account:read_write OAuth scope to use this operation.

Parent and child accounts

In a parent and child account environment, 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.

Learn more...

Learn more...

REPLACE linode.profile.profile
SET 
data__authorized_keys = '{{ authorized_keys }}',
data__email = '{{ email }}',
data__email_notifications = {{ email_notifications }},
data__ip_whitelist_enabled = {{ ip_whitelist_enabled }},
data__lish_auth_method = '{{ lish_auth_method }}',
data__restricted = {{ restricted }},
data__timezone = '{{ timezone }}',
data__two_factor_auth = {{ two_factor_auth }}
WHERE 

RETURNING
authentication_type,
authorized_keys,
email,
email_notifications,
ip_whitelist_enabled,
lish_auth_method,
referrals,
restricted,
timezone,
two_factor_auth,
uid,
username,
verified_phone_number;

Lifecycle Methods

get_user_preferences

View a list of user preferences tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. User preferences are available for each OAuth client registered to your account, and as such an account can have multiple user preferences. OAuth scopes.

<br /> account:read_only<br />

Learn more...

EXEC linode.profile.profile.get_user_preferences 
;

put_user_preferences

Updates a user's preferences. These preferences are tied to the OAuth client that generated the token making the request. The user preferences endpoints allow consumers of the API to store arbitrary JSON data, such as a user's font size preference or preferred display name. An account may have multiple preferences. Preferences, and the pertaining request body, may contain any arbitrary JSON data that the user would like to store. OAuth scopes.

<br /> account:read_write<br />

Learn more...

EXEC linode.profile.profile.put_user_preferences 
;