@akamai/openapi-ts
    Preparing search index...

    Type Alias PutProfileData

    type PutProfileData = {
        body: {
            authentication_type?: "password" | "github";
            authorized_keys?: string[] | null;
            email?: string;
            email_notifications?: boolean;
            ip_whitelist_enabled?: boolean;
            lish_auth_method?: "password_keys" | "keys_only" | "disabled";
            referrals?: {
                code?: string;
                completed?: number;
                credit?: number;
                pending?: number;
                total?: number;
                url?: string;
            };
            restricted?: boolean;
            timezone?: string;
            two_factor_auth?: boolean;
            uid?: number;
            username?: string;
            verified_phone_number?: string
            | null;
        };
        path?: never;
        query?: never;
        url: "profile";
    }
    Index

    Properties

    body path? query? url

    Properties

    body

    body: {
        authentication_type?: "password" | "github";
        authorized_keys?: string[] | null;
        email?: string;
        email_notifications?: boolean;
        ip_whitelist_enabled?: boolean;
        lish_auth_method?: "password_keys" | "keys_only" | "disabled";
        referrals?: {
            code?: string;
            completed?: number;
            credit?: number;
            pending?: number;
            total?: number;
            url?: string;
        };
        restricted?: boolean;
        timezone?: string;
        two_factor_auth?: boolean;
        uid?: number;
        username?: string;
        verified_phone_number?: string
        | null;
    }

    A profile represents your user in our system. This is where you can change information about your user. This information is available to any OAuth client regardless of requested scopes, and you can use it to populate user information in third-party applications.

    Type Declaration

    • Optionalauthentication_type?: "password" | "github"

      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.

    • Optionalauthorized_keys?: string[] | null

      Your user can use these SSH Keys to access Lish. This value is ignored if lish_auth_method is disabled.

    • Optionalemail?: string

      Your email address. We use this address for Akamai Cloud Computing-related communication.

    • Optionalemail_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.

    • Optionalip_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.

    • Optionallish_auth_method?: "password_keys" | "keys_only" | "disabled"

      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.

    • Optional Readonlyreferrals?: {
          code?: string;
          completed?: number;
          credit?: number;
          pending?: number;
          total?: number;
          url?: string;
      }

      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.

      • Optional Readonlycode?: string

        Read-only Your referral code. If others use this when signing up for Linode, you receive an account credit.

      • Optional Readonlycompleted?: number

        Read-only The number of completed sign-ups that used your referral code.

      • Optional Readonlycredit?: number

        Read-only Your referral program account credit in US dollars.

      • Optional Readonlypending?: number

        Read-only The number of pending sign-ups that used your referral code. Akamai gives you credit for these sign-ups once they've completed.

      • Optional Readonlytotal?: number

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

      • Optional Readonlyurl?: string

        Read-only The referral URL that Akamai uses to direct others to sign up for Akamai Cloud Computing with your referral code.

    • Optionalrestricted?: 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.

    • Optionaltimezone?: 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.

    • Optionaltwo_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.

    • Optional Readonlyuid?: number

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

    • Optional Readonlyusername?: string

      Read-only Your username, used for logging in to our system.

    • Optional Readonlyverified_phone_number?: string | null

      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.

    path?: never
    query?: never
    url: "profile"

    Settings

    Member Visibility

    On This Page

    Properties