Remove Groups

Removes groups maintained in Access Control using either a CSV file upload (v1) or request payload (v2). You can use the Upload REST API to upload the file to the environment.

Both APIs provide details about successful and failed group removal requests, including failure reasons and counts of passed and failed records.

The v1 API requires an ANSI or UTF-8 encoded CSV file containing group names. Before running the API, the file must be uploaded to the environment using the Upload REST API. The user running this API must be authorized to perform this action and should be a Service Administrator in the environment where groups are to be removed. The v1 API is asynchronous and returns a Job ID that can be used to monitor the status of the operation.

In v1, a response status of -1 indicates that group removal is still in progress. Any non-zero status value indicates failure of removing groups.

The v2 API accepts group details directly in the request payload. This topic describes the simplified v2 version of the REST API. This version contains all parameters in the payload and does not require URL encoding while calling the REST APIs, which makes the v2 API easier to use. The user running this API must be authorized to perform this action and should be a Service Administrator in the environment where groups are to be removed. The v2 API is synchronous and returns the outcome of the operation directly in the response.

Required Roles

Service Administrator or any application role and the Access Control - Manage granular role