Function: getGroups()

function getGroups(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  itemsPerPage?: number;
  Resources?: object[];
  schemas?: string[];
  startIndex?: number;
  totalResults?: number;
}>;

Defined in: src/userProvisioning/api/groups.ts:173

Get groups from the directory. Filter the groups by name supported with a single exact match (eq) against the displayName attribute.

Note: While this API enables pagination, sorting functionality is not supported.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ count?: number; directoryId: string; filter?: string; startIndex?: number; }	-
parameters.count?	number	Desired maximum number of query results in the list response page.
parameters.directoryId?	string	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
parameters.filter?	string	Filter for displayName. Example: displayName eq "SCIM_GROUP"
parameters.startIndex?	number	A 1-based index of the first query result.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; itemsPerPage?: number; Resources?: object[]; schemas?: string[]; startIndex?: number; totalResults?: number; }>