Function findGroups

findGroups(
    client: Client,
    parameters?: {
        exclude?: string;
        maxResults?: string;
        query?: string;
        userName?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        groups?: {
            html?: string;
            labels?: {
                text?: string;
                title?: string;
                type?: string & {}
                | "ADMIN"
                | "SINGLE"
                | "MULTIPLE";
                [key: string]: unknown;
            }[];
            name?: string;
            [key: string]: unknown;
        }[];
        header?: string;
        total?: number;
        [key: string]: unknown;
    },
>
Returns groups with substrings matching a given query
Parameters
- client: Client
- Optionalparameters: { exclude?: string; maxResults?: string; query?: string; userName?: string }
  - Optionalexclude?: string
    
    List of groups to exclude
  - OptionalmaxResults?: string
    
    Maximum number of results to return
  - Optionalquery?: string
    
    A String to match groups against
  - OptionaluserName?: string
    
    Username for the context
- Optionaloptions: RequestOptions
Returns Promise<
    {
        groups?: {
            html?: string;
            labels?: {
                text?: string;
                title?: string;
                type?: string & {}
                | "ADMIN"
                | "SINGLE"
                | "MULTIPLE";
                [key: string]: unknown;
            }[];
            name?: string;
            [key: string]: unknown;
        }[];
        header?: string;
        total?: number;
        [key: string]: unknown;
    },
>
- Defined in src/server/api/groups.ts:106

Function findGroups

Parameters

`Optional`exclude?: string

`Optional`maxResults?: string

`Optional`query?: string

`Optional`userName?: string

Settings

Function findGroups

Parameters

Optionalexclude?: string

OptionalmaxResults?: string

Optionalquery?: string

OptionaluserName?: string

Returns Promise< { groups?: { html?: string; labels?: { text?: string; title?: string; type?: string & {} | "ADMIN" | "SINGLE" | "MULTIPLE"; [key: string]: unknown; }[]; name?: string; [key: string]: unknown; }[]; header?: string; total?: number; [key: string]: unknown; },>

Settings

`Optional`exclude?: string

`Optional`maxResults?: string

`Optional`query?: string

`Optional`userName?: string

Returns Promise<
{
groups?: {
html?: string;
labels?: {
text?: string;
title?: string;
type?: string & {}
| "ADMIN"
| "SINGLE"
| "MULTIPLE";
[key: string]: unknown;
}[];
name?: string;
[key: string]: unknown;
}[];
header?: string;
total?: number;
[key: string]: unknown;
},
>