Interface BitwardenNodeParameters

Source
interface BitwardenNodeParameters {
    accessAll?: boolean;
    additionalFields?: {
        collections?: unknown[];
        externalId?: string;
    };
    collectionId?: string;
    email?: string;
    filters?: {
        actingUserId?: string;
        end?: string;
        itemID?: string;
        start?: string;
    };
    groupId?: string;
    groupIds?: string;
    limit?: number;
    memberId?: string;
    memberIds?: string;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "getMembers"
    | "updateMembers"
    | "getGroups"
    | "updateGroups";
    resource?: "event"
    | "collection"
    | "group"
    | "member";
    returnAll?: boolean;
    type?: 0 | 1 | 3 | 2;
    updateFields?:
        | { externalId?: string; groups?: unknown[] }
        | {
            accessAll?: boolean;
            collections?: unknown[];
            externalId?: string;
            name?: string;
        }
        | {
            accessAll?: boolean;
            collections?: unknown[];
            externalId?: string;
            type?: 0
            | 1
            | 3
            | 2;
        };
}

Properties§

Source§

readonly accessAll?: boolean

Whether to allow this group to access all collections within the organization, instead of only its associated collections. If set to true, this option overrides any collection assignments.

Source§

readonly additionalFields?: { collections?: unknown[]; externalId?: string }

Default: {}

Source§

readonly collectionId?: string

The identifier of the collection

Source§

readonly email?: string

The email of the member to update

Source§

readonly filters?: {
    actingUserId?: string;
    end?: string;
    itemID?: string;
    start?: string;
}

Default: {}

Source§

readonly groupId?: string

The identifier of the group

Source§

readonly groupIds?: string

Comma-separated list of IDs of groups to set for a member

Source§

readonly limit?: number

Max number of results to return Default: 10 Type options: {"minValue":1}

Source§

readonly memberId?: string

The identifier of the member

Source§

readonly memberIds?: string

Comma-separated list of IDs of members to set in a group

Source§

readonly name?: string

The name of the group to create

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "getMembers"
    | "updateMembers"
    | "getGroups"
    | "updateGroups"

Default: "get"

Source§

readonly resource?: "event" | "collection" | "group" | "member"

Default: "collection"

Source§

readonly returnAll?: boolean

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

Source§

readonly type?: 0 | 1 | 3 | 2

Default: 2

Source§

readonly updateFields?:
    | { externalId?: string; groups?: unknown[] }
    | {
        accessAll?: boolean;
        collections?: unknown[];
        externalId?: string;
        name?: string;
    }
    | {
        accessAll?: boolean;
        collections?: unknown[];
        externalId?: string;
        type?: 0
        | 1
        | 3
        | 2;
    }

Default: {}