nodes/generated

Interface GSuiteAdminNodeParameters

Source
interface GSuiteAdminNodeParameters {
    action?: "reenable" | "disable";
    additionalFields?:
        | { description?: string }
        | {
            changePasswordAtNextLogin?: boolean;
            customFields?: {
                fieldValues: {
                    fieldName: string;
                    schemaName?: string;
                    value: string;
                }[];
            };
            emailUi?: {
                emailValues: {
                    address?: string;
                    type?: "home"
                    | "work"
                    | "other";
                }[];
            };
            phoneUi?: {
                phoneValues: {
                    primary?: boolean;
                    type?: | "main"
                    | "custom"
                    | "home"
                    | "work"
                    | "mobile"
                    | "other"
                    | "assistant"
                    | "radio"
                    | "callback"
                    | "car"
                    | "company_main"
                    | "grand_central"
                    | "home_fax"
                    | "isdn"
                    | "other_fax"
                    | "pager"
                    | "telex"
                    | "tty_tdd"
                    | "work_fax"
                    | "work_mobile"
                    | "work_pager";
                    value?: string;
                }[];
            };
            roles?: (
                | "directorySyncAdmin"
                | "groupsAdmin"
                | "groupsEditor"
                | "groupsReader"
                | "helpDeskAdmin"
                | "inventoryReportingAdmin"
                | "mobileAdmin"
                | "servicesAdmin"
                | "storageAdmin"
                | "superAdmin"
                | "userManagement"
            )[];
        };
    customFieldMask?: unknown[];
    deviceId?: { mode: "list"
    | "deviceId"; value: string };
    domain?: string;
    email?: string;
    fields?: (
        | "name"
        | "suspended"
        | "creationTime"
        | "isAdmin"
        | "kind"
        | "lastLoginTime"
        | "primaryEmail"
    )[];
    filter?: | { orgUnitPath?: string; query?: string }
    | {
        customer?: string;
        domain?: string;
        query?: string;
        userId?: string;
    }
    | {
        customer?: string;
        domain?: string;
        query?: string;
        showDeleted?: boolean;
    };
    firstName?: string;
    groupId?: | { mode: "list"
    | "GroupId"; value: string }
    | { mode: "list" | "groupId"; value: string };
    includeChildOrgunits?: boolean;
    lastName?: string;
    limit?: number;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "addToGroup"
        | "removeFromGroup"
        | "changeStatus";
    output?: "raw"
    | "simplified"
    | "select";
    password?: string;
    projection?: "custom" | "basic" | "full";
    resource?: "user" | "group" | "device";
    returnAll?: boolean;
    sort?:
        | {
            sortRules: {
                orderBy?: | "status"
                | "annotatedLocation"
                | "annotatedUser"
                | "lastSync"
                | "notes"
                | "serialNumber";
                sortBy?: "ascending"
                | "descending";
            };
        }
        | {
            sortRules: {
                orderBy?: "email";
                sortOrder?: "ASCENDING"
                | "DESCENDING";
            };
        }
        | {
            sortRules: {
                orderBy?: "email"
                | "familyName"
                | "givenName";
                sortOrder?: "ASCENDING" | "DESCENDING";
            };
        };
    updateFields?: | {
        description?: string;
        email?: string;
        name?: string;
    }
    | {
        archived?: boolean;
        changePasswordAtNextLogin?: boolean;
        customFields?: {
            fieldValues: {
                fieldName: string;
                schemaName?: string;
                value: string;
            }[];
        };
        emailUi?: {
            emailValues: {
                address?: string;
                type?: "home"
                | "work"
                | "other";
            }[];
        };
        firstName?: string;
        lastName?: string;
        password?: string;
        phoneUi?: {
            phoneValues: {
                primary?: boolean;
                type?: | "main"
                | "custom"
                | "home"
                | "work"
                | "mobile"
                | "other"
                | "assistant"
                | "radio"
                | "callback"
                | "car"
                | "company_main"
                | "grand_central"
                | "home_fax"
                | "isdn"
                | "other_fax"
                | "pager"
                | "telex"
                | "tty_tdd"
                | "work_fax"
                | "work_mobile"
                | "work_pager";
                value?: string;
            }[];
        };
        primaryEmail?: string;
        roles?: (
            | "directorySyncAdmin"
            | "groupsAdmin"
            | "groupsEditor"
            | "groupsReader"
            | "helpDeskAdmin"
            | "inventoryReportingAdmin"
            | "mobileAdmin"
            | "servicesAdmin"
            | "storageAdmin"
            | "superAdmin"
            | "userManagement"
        )[];
        suspendUi?: boolean;
    };
    updateOptions?: {
        annotatedAssetId?: string;
        annotatedLocation?: string;
        annotatedUser?: string;
        notes?: string;
        orgUnitPath?: string;
    };
    userId?: {
        mode: "list"
        | "userEmail"
        | "userId";
        value: string;
    };
    username?: string;
}

Properties§

Source§

readonly action?: "reenable" | "disable"

Set the status of a device Default: "reenable"

Source§

readonly additionalFields?:
    | { description?: string }
    | {
        changePasswordAtNextLogin?: boolean;
        customFields?: {
            fieldValues: {
                fieldName: string;
                schemaName?: string;
                value: string;
            }[];
        };
        emailUi?: {
            emailValues: {
                address?: string;
                type?: "home"
                | "work"
                | "other";
            }[];
        };
        phoneUi?: {
            phoneValues: {
                primary?: boolean;
                type?: | "main"
                | "custom"
                | "home"
                | "work"
                | "mobile"
                | "other"
                | "assistant"
                | "radio"
                | "callback"
                | "car"
                | "company_main"
                | "grand_central"
                | "home_fax"
                | "isdn"
                | "other_fax"
                | "pager"
                | "telex"
                | "tty_tdd"
                | "work_fax"
                | "work_mobile"
                | "work_pager";
                value?: string;
            }[];
        };
        roles?: (
            | "directorySyncAdmin"
            | "groupsAdmin"
            | "groupsEditor"
            | "groupsReader"
            | "helpDeskAdmin"
            | "inventoryReportingAdmin"
            | "mobileAdmin"
            | "servicesAdmin"
            | "storageAdmin"
            | "superAdmin"
            | "userManagement"
        )[];
    }

Default: {}

Source§

readonly customFieldMask?: unknown[]

A comma-separated list of schema names. All fields from these schemas are fetched. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getSchemas"}

Source§

readonly deviceId?: { mode: "list" | "deviceId"; value: string }

Select the device you want to retrieve Default: {"mode":"list","value":""}

Source§

readonly domain?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getDomains"}

Source§

readonly email?: string

The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The email must be unique

Source§

readonly fields?: (
    | "name"
    | "suspended"
    | "creationTime"
    | "isAdmin"
    | "kind"
    | "lastLoginTime"
    | "primaryEmail"
)[]

Fields to include in the response when "Select Included Fields" is chosen Default: []

Source§

readonly filter?:
    | { orgUnitPath?: string; query?: string }
    | {
        customer?: string;
        domain?: string;
        query?: string;
        userId?: string;
    }
    | {
        customer?: string;
        domain?: string;
        query?: string;
        showDeleted?: boolean;
    }

Default: {}

Source§

readonly firstName?: string

Source§

readonly groupId?:
    | { mode: "list"
    | "GroupId"; value: string }
    | { mode: "list" | "groupId"; value: string }

Select the group to perform the operation on Default: {"mode":"list","value":""}

Source§

readonly includeChildOrgunits?: boolean

Whether to include devices from organizational units below your specified organizational unit

Source§

readonly lastName?: string

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

Source§

readonly name?: string

The group's display name

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "addToGroup"
    | "removeFromGroup"
    | "changeStatus"

Default: "get"

Source§

readonly output?: "raw" | "simplified" | "select"

Default: "simplified"

Source§

readonly password?: string

Stores the password for the user account. A minimum of 8 characters is required. The maximum length is 100 characters. Type options: {"password":true}

Source§

readonly projection?: "custom" | "basic" | "full"

What subset of fields to fetch for this device Default: "basic"

Source§

readonly resource?: "user" | "group" | "device"

Default: "user"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly sort?:
    | {
        sortRules: {
            orderBy?: | "status"
            | "annotatedLocation"
            | "annotatedUser"
            | "lastSync"
            | "notes"
            | "serialNumber";
            sortBy?: "ascending"
            | "descending";
        };
    }
    | {
        sortRules: {
            orderBy?: "email";
            sortOrder?: "ASCENDING"
            | "DESCENDING";
        };
    }
    | {
        sortRules: {
            orderBy?: "email"
            | "familyName"
            | "givenName";
            sortOrder?: "ASCENDING" | "DESCENDING";
        };
    }

Define sorting rules for the results Default: {}

Source§

readonly updateFields?:
    | {
        description?: string;
        email?: string;
        name?: string;
    }
    | {
        archived?: boolean;
        changePasswordAtNextLogin?: boolean;
        customFields?: {
            fieldValues: {
                fieldName: string;
                schemaName?: string;
                value: string;
            }[];
        };
        emailUi?: {
            emailValues: {
                address?: string;
                type?: "home"
                | "work"
                | "other";
            }[];
        };
        firstName?: string;
        lastName?: string;
        password?: string;
        phoneUi?: {
            phoneValues: {
                primary?: boolean;
                type?: | "main"
                | "custom"
                | "home"
                | "work"
                | "mobile"
                | "other"
                | "assistant"
                | "radio"
                | "callback"
                | "car"
                | "company_main"
                | "grand_central"
                | "home_fax"
                | "isdn"
                | "other_fax"
                | "pager"
                | "telex"
                | "tty_tdd"
                | "work_fax"
                | "work_mobile"
                | "work_pager";
                value?: string;
            }[];
        };
        primaryEmail?: string;
        roles?: (
            | "directorySyncAdmin"
            | "groupsAdmin"
            | "groupsEditor"
            | "groupsReader"
            | "helpDeskAdmin"
            | "inventoryReportingAdmin"
            | "mobileAdmin"
            | "servicesAdmin"
            | "storageAdmin"
            | "superAdmin"
            | "userManagement"
        )[];
        suspendUi?: boolean;
    }

Default: {}

Source§

readonly updateOptions?: {
    annotatedAssetId?: string;
    annotatedLocation?: string;
    annotatedUser?: string;
    notes?: string;
    orgUnitPath?: string;
}

Default: {}

Source§

readonly userId?: { mode: "list" | "userEmail" | "userId"; value: string }

Select the user to perform the operation on Default: {"mode":"list","value":""}

Source§

readonly username?: string

The username that will be set to the user. Example: If you domain is example.com and you set the username to n.smith then the user's final email address will be n.smith@example.com.