Function: findGroups()

function findGroups(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  groups?: object[];
  header?: string;
  total?: number;
}>;

Defined in: src/server/api/groups.ts:106

Returns groups with substrings matching a given query

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ exclude?: string; maxResults?: string; query?: string; userName?: string; }	-
parameters.exclude?	string	List of groups to exclude
parameters.maxResults?	string	Maximum number of results to return
parameters.query?	string	A String to match groups against
parameters.userName?	string	Username for the context
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; groups?: object[]; header?: string; total?: number; }>