Function: deleteGroup()

function deleteGroup(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Delete a group from a directory if you don’t need this group anymore. This removes any app access and permissions granted by this group from all members. A member can still access an app if they’re in another group that grants access to the same app.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ directoryId: string; groupId: string; orgId: string; }	-
parameters.directoryId	string	A directory has a unique ID. Use the Get directories endpoint to find the directory ID.
parameters.groupId?	string	A group has a unique ID. Use the Get groups endpoint to find the group ID.
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<void>