Function: getUsersFromGroup()

function getUsersFromGroup(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  self?: string;
  startAt?: number;
  total?: number;
  values?: object[];
}>;

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

Returns a paginated list of users who are members of the specified group and its subgroups

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ groupname: string; includeInactiveUsers?: string; maxResults?: string; startAt?: string; }	-
parameters.groupname	string	The group name.
parameters.includeInactiveUsers?	string	Include inactive users.
parameters.maxResults?	string	The maximum number of users to return.
parameters.startAt?	string	The index of the first user in group to return.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; self?: string; startAt?: number; total?: number; values?: object[]; }>