Skip to content

Function: deleteGroup() ​

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

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

Deletes a group to remove the group from the organization's directory.

Note: An attempt to delete a non-existent group will fail with a 404 (Resource Not found) error.

Note: Deleting a synced group from your identity provider will delete the group from your organization's directory and associated sites.

  1. If this group is used for allocating product license (granting role in a product), then members of this group may lose access to corresponding product after group deletion.
  2. If this group is used to grant permissions in product, then members of this group may lose their permissions in the corresponding product.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ directoryId: string; id: string; }-
parameters.directoryIdstringThe SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
parameters.id?stringUnique SCIM id that serves as reference to the group. Use the Get groups API to get the SCIM id.
options?RequestOptions-

Returns ​

Promise<void>