Function: getGroup()

function getGroup(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  displayName?: string;
  externalId?: string;
  id?: string;
  members?: object[];
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  schemas?: string[];
}>;

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

Gets the details of a group based on the id.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ directoryId: string; id: string; }	-
parameters.directoryId	string	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
parameters.id?	string	Unique SCIM id that serves as reference to the group. Use the Get groups API to get the SCIM id.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; displayName?: string; externalId?: string; id?: string; members?: object[]; meta?: { [key: string]: unknown; created?: Date; lastModified?: Date; location?: string; resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY"; }; schemas?: string[]; }>