Function: getGroup()

function getGroup(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     counts?: {
      [key: string]: unknown;
        resources?: number;
        users?: number;
     };
     description?: string;
     directoryId?: string;
     externalSynced?: boolean;
     id?: string;
     links?: {
      [key: string]: unknown;
        self?: string | null;
     };
     managedBy?: string;
     managementAccess?: {
      [key: string]: unknown;
        deletable?: boolean;
        modifiable?: boolean;
        readable?: boolean;
     };
     name?: string;
  };
}>;

Defined in: src/admin/api/groups.ts:195

Returns the details of a group.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ directoryId: string; groupId: string; orgId: string; }	-
parameters.directoryId	string	Unique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
parameters.groupId?	string	Unique ID associated with a group.
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; counts?: { [key: string]: unknown; resources?: number; users?: number; }; description?: string; directoryId?: string; externalSynced?: boolean; id?: string; links?: { [key: string]: unknown; self?: string | null; }; managedBy?: string; managementAccess?: { [key: string]: unknown; deletable?: boolean; modifiable?: boolean; readable?: boolean; }; name?: string; }; }>