Interface ListGroupsOptions`Experimental`

Options for listing Partner groups.

Partner API surface; shape may change as the Partner API docs evolve.

interface ListGroupsOptions {
    groupName?: string;
    pageSize?: number;
    signal?: AbortSignal;
    startGroupId?: GroupId;
}

Properties

groupName?: string

Optional group name filter. Multiple groups may share the same name.

pageSize?: number

Maximum groups to return in this page. Forwarded to maxGroupCount.

signal?: AbortSignal

Abort signal for cancelling the request.

startGroupId?: GroupId

Group ID to start listing from for pagination.