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

    Type Alias GetUserGrantsResponses

    type GetUserGrantsResponses = {
        "200": {
            database: {
                id: number;
                label: string;
                permissions: "read_only" | "read_write";
            }[];
            domain: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            firewall: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            global: {
                account_access: "read_only"
                | "read_write";
                add_databases: boolean;
                add_domains: boolean;
                add_firewalls: boolean;
                add_images: boolean;
                add_linodes: boolean;
                add_longview: boolean;
                add_nodebalancers: boolean;
                add_stackscripts: boolean;
                add_volumes: boolean;
                add_vpcs: boolean;
                cancel_account: boolean;
                child_account_access: boolean | null;
                longview_subscription: boolean;
            };
            image: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            linode: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            longview: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            nodebalancer: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            stackscript: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            volume: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
            vpc: {
                id: number;
                label: string;
                permissions: "read_only"
                | "read_write";
            }[];
        };
        "204": void;
    }
    Index

    Properties

    Properties

    "200": {
        database: {
            id: number;
            label: string;
            permissions: "read_only" | "read_write";
        }[];
        domain: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        firewall: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        global: {
            account_access: "read_only"
            | "read_write";
            add_databases: boolean;
            add_domains: boolean;
            add_firewalls: boolean;
            add_images: boolean;
            add_linodes: boolean;
            add_longview: boolean;
            add_nodebalancers: boolean;
            add_stackscripts: boolean;
            add_volumes: boolean;
            add_vpcs: boolean;
            cancel_account: boolean;
            child_account_access: boolean | null;
            longview_subscription: boolean;
        };
        image: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        linode: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        longview: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        nodebalancer: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        stackscript: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        volume: {
            id: number;
            label: string;
            permissions: "read_only"
            | "read_write";
        }[];
        vpc: { id: number; label: string; permissions: "read_only"
        | "read_write" }[];
    }

    The User's grants.

    Type Declaration

    • database: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has for individual Managed Databases on this account.

    • domain: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has for individual domains on this account.

    • firewall: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has for individual firewalls on this account.

    • global: {
          account_access: "read_only" | "read_write";
          add_databases: boolean;
          add_domains: boolean;
          add_firewalls: boolean;
          add_images: boolean;
          add_linodes: boolean;
          add_longview: boolean;
          add_nodebalancers: boolean;
          add_stackscripts: boolean;
          add_volumes: boolean;
          add_vpcs: boolean;
          cancel_account: boolean;
          child_account_access: boolean | null;
          longview_subscription: boolean;
      }

      The grants the user has to all resources on your account.

      • account_access: "read_only" | "read_write"

        The level of access this user has to account-level actions, like billing information and user management.

        📘

        A restricted user can't be used to manage users, even if this is set to read-write. Only unrestricted users can manage other users on an account.

        Parent and child accounts

        In a parent and child account environment, this grant can be added to a child account user, to give the user read-write access. This gives the child user unrestricted access to expected management operations, such as creating other child users. However, child users don't have write access to billing operations. The API issues a specific error message if a write operation is attempted by a child user.

      • add_databases: boolean

        Whether this user can add Managed Databases on the account.

      • add_domains: boolean

        Whether this user can add domains on the account.

      • add_firewalls: boolean

        Whether this user can add Firewalls on the account.

      • add_images: boolean

        Whether this user can create images from disks on your Linodes, on the account.

      • add_linodes: boolean

        Whether this user can create Linodes.

      • add_longview: boolean

        Whether this user can create Longview clients and view the current plan.

      • add_nodebalancers: boolean

        Whether this user can add NodeBalancers on the account.

      • add_stackscripts: boolean

        Whether this user can add StackScripts on the account.

      • add_volumes: boolean

        Whether this user can add volumes on the account.

      • add_vpcs: boolean

        Whether this user can add Virtual Private Clouds (VPCs) on the account.

      • cancel_account: boolean

        Whether this user can cancel the entire account.

      • child_account_access: boolean | null

        In a parent and child account environment, this gives a parent account access to operations that can be used to manage child accounts. Unrestricted parent account users have access to this grant, while restricted parent users don't. An unrestricted parent user can set this to true to add this grant to a restricted parent user. Displayed as null for all non-parent accounts.

      • longview_subscription: boolean

        Whether this user can manage your account's Longview subscription.

    • image: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has for individual images on this account.

    • linode: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has for individual Linodes on this account.

    • longview: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has for individual Longview Clients on this account.

    • nodebalancer: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has for individual NodeBalancers on this account.

    • stackscript: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this User has for individual StackScripts on this account.

    • volume: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has individual Block Storage Volumes on this account.

    • vpc: { id: number; label: string; permissions: "read_only" | "read_write" }[]

      The grants this user has individual Virtual Private Clouds (VPCs) on this account.

    "204": void

    This is an unrestricted user. These users don't use grants. They can access everything on the account and perform all actions.