Type Alias GrantsResponseWritable

type GrantsResponseWritable = {
    database?: { id?: number; permissions?: "read_only" | "read_write" }[];
    domain?: { id?: number; permissions?: "read_only" | "read_write" }[];
    firewall?: { id?: number; 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; permissions?: "read_only"
    | "read_write" }[];
    linode?: { id?: number; permissions?: "read_only" | "read_write" }[];
    longview?: { id?: number; permissions?: "read_only" | "read_write" }[];
    nodebalancer?: { id?: number; permissions?: "read_only" | "read_write" }[];
    stackscript?: { id?: number; permissions?: "read_only" | "read_write" }[];
    volume?: { id?: number; permissions?: "read_only" | "read_write" }[];
    vpc?: { id?: number; permissions?: "read_only" | "read_write" }[];
}

Index

Properties

database? domain? firewall? global? image? linode? longview? nodebalancer? stackscript? volume? vpc?

Properties

`Optional`database

database?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`domain

domain?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`firewall

firewall?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`global

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.

Type Declaration

Optionalaccount_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.
Optionaladd_databases?: boolean
Whether this user can add Managed Databases on the account.
Optionaladd_domains?: boolean
Whether this user can add domains on the account.
Optionaladd_firewalls?: boolean
Whether this user can add Firewalls on the account.
Optionaladd_images?: boolean
Whether this user can create images from disks on your Linodes, on the account.
Optionaladd_linodes?: boolean
Whether this user can create Linodes.
Optionaladd_longview?: boolean
Whether this user can create Longview clients and view the current plan.
Optionaladd_nodebalancers?: boolean
Whether this user can add NodeBalancers on the account.
Optionaladd_stackscripts?: boolean
Whether this user can add StackScripts on the account.
Optionaladd_volumes?: boolean
Whether this user can add volumes on the account.
Optionaladd_vpcs?: boolean
Whether this user can add Virtual Private Clouds (VPCs) on the account.
Optionalcancel_account?: boolean
Whether this user can cancel the entire account.
Optionalchild_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.
Optionallongview_subscription?: boolean
Whether this user can manage your account's Longview subscription.

`Optional`image

image?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`linode

linode?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`longview

longview?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`nodebalancer

nodebalancer?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`stackscript

stackscript?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`volume

volume?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

`Optional`vpc

vpc?: { id?: number; permissions?: "read_only" | "read_write" }[]

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

Type Declaration

Optionalid?: number
The unique identifier of the resource this grant applies to.
Optionalpermissions?: "read_only" | "read_write"
The level of access this user has to this entity. If null, this user has no access.

Type Alias GrantsResponseWritable

Index

Properties

Properties

Optionaldatabase

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionaldomain

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionalfirewall

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionalglobal

Type Declaration

Optionalaccount_access?: "read_only" | "read_write"

Optionaladd_databases?: boolean

Optionaladd_domains?: boolean

Optionaladd_firewalls?: boolean

Optionaladd_images?: boolean

Optionaladd_linodes?: boolean

Optionaladd_longview?: boolean

Optionaladd_nodebalancers?: boolean

Optionaladd_stackscripts?: boolean

Optionaladd_volumes?: boolean

Optionaladd_vpcs?: boolean

Optionalcancel_account?: boolean

Optionalchild_account_access?: boolean | null

Optionallongview_subscription?: boolean

Optionalimage

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionallinode

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionallongview

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionalnodebalancer

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionalstackscript

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionalvolume

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Optionalvpc

Type Declaration

Optionalid?: number

Optionalpermissions?: "read_only" | "read_write"

Settings

On This Page

`Optional`database

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`domain

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`firewall

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`global

`Optional`account_access?: "read_only" | "read_write"

`Optional`add_databases?: boolean

`Optional`add_domains?: boolean

`Optional`add_firewalls?: boolean

`Optional`add_images?: boolean

`Optional`add_linodes?: boolean

`Optional`add_longview?: boolean

`Optional`add_nodebalancers?: boolean

`Optional`add_stackscripts?: boolean

`Optional`add_volumes?: boolean

`Optional`add_vpcs?: boolean

`Optional`cancel_account?: boolean

`Optional`child_account_access?: boolean | null

`Optional`longview_subscription?: boolean

`Optional`image

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`linode

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`longview

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`nodebalancer

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`stackscript

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`volume

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"

`Optional`vpc

`Optional`id?: number

`Optional`permissions?: "read_only" | "read_write"