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

    Type Alias PutUserData

    type PutUserData = {
        body?: {
            email?: string;
            last_login?:
                | { login_datetime?: string; status?: "successful"
                | "failed" }
                | null;
            password_created?: string | null;
            restricted?: boolean;
            ssh_keys?: string[];
            tfa_enabled?: boolean;
            username?: string;
            verified_phone_number?: string | null;
        };
        path: { username: string };
        query?: never;
        url: "account/users/{username}";
    }
    Index

    Properties

    body? path query? url

    Properties

    Optionalbody

    body?: {
        email?: string;
        last_login?:
            | { login_datetime?: string; status?: "successful"
            | "failed" }
            | null;
        password_created?: string | null;
        restricted?: boolean;
        ssh_keys?: string[];
        tfa_enabled?: boolean;
        username?: string;
        verified_phone_number?: string | null;
    }

    A user on your account. Unrestricted users can log in and access information about your account, while restricted users may only access entities or perform actions they've been granted access to.

    Type Declaration

    • Optionalemail?: string

      This user's email address. Akamai uses this address for account management communications.

    • Optional Readonlylast_login?: { login_datetime?: string; status?: "successful" | "failed" } | null

      Read-only Details on this user's last login attempt. Returned as null if this user hasn't attempted a login since it was created. You can run the List user logins operation for additional login information.

    • Optional Readonlypassword_created?: string | null

      Read-only When this user's current password was created. You initially create a password during the account sign-up process, and you can update it using the Reset Password webpage. Returned as null if this user doesn't have a password set.

    • Optionalrestricted?: boolean

      If true, this user needs specific access granted to perform actions or access entities on your account. Run List a user's grants for details on how to configure grants for a restricted user.

    • Optional Readonlyssh_keys?: string[]

      Read-only A list of the labels for SSH keys added by this user. Users can add keys with the Add an SSH key operation. These keys are deployed when this user is included in the authorized_users field of the following requests:

    • Optional Readonlytfa_enabled?: boolean

      Read-only Whether this user has Two Factor Authentication (TFA) enabled. Run the Create a two factor secret operation to enable TFA.

    • Optionalusername?: string

      Filterable The name of this user. This user needs to use this value to log in. It may also display alongside actions this user performs, including events or public StackScripts.

    • Optional Readonlyverified_phone_number?: string | null

      Read-only The verified phone number for this user profile. Returned as null if the user doesn't have a verified phone number.

    path: { username: string }

    Type Declaration

    • username: string

      The username to look up.

    query?: never
    url: "account/users/{username}"

    Settings

    Member Visibility

    On This Page

    Properties