Delete a group from a specified tenant.

Entitlement required: manageUserGroups (Manage users and groups), or manageAllUserGroups (Synchronize users and groups), or manageUserStandardGroups (Manage users and standard groups).
Note: You only need one entitlement, but you can have more than one.

An email is sent to each regular user member of the group. Federated user members do not get an email notification. The email template for branding is at "notifications/user_management/group/{locale}/group_deleted_email.xml". Pass in the themeId query parameter to brand the email template for notifications. If a group has more than 10,000 members then the members are not notified when the group is deleted.

To turn off email notifications, send notifyType=NONE as a query parameter.

Path Params
string
required

The unique identifier of the group to be deleted. This identifier is passed in the path of the URL.

Query Params
string

An optional query parameter that denotes the notification type. If not present, the EMAIL notification is used. Specify NONE if no notification to the user is required.

string

The identifier of the theme that you want to apply.

Responses
204

Success. No content.

Language
URL
Choose an example:
application/scim+json