Remove Groups (v1)

Removes groups listed in an ANSI or UTF-8 encoded CSV file maintained in Access Control. You can use the Upload REST API to upload the file to the environment. The file format is as follows:

Group Name
GroupA
GroupB

The user running this API must be authorized to perform this action. This API should be run only by a service administrator in the environment where a group is to be removed.

The presence of status -1 in the response indicates that the removal in progress. Use the job status URI to determine whether the removal is complete. Any non-zero status except -1 indicates failure. With this API, you can see which records failed and the reason why they failed in addition to how many records passed and failed.

This API is version v1.

Required Roles

Service Administrator or Access Control Manager

REST Resource

DELETE /interop/rest/security/<api_version>/groups

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Table 12-53 Tasks for Remove Groups

Task	Request	REST Resource
Remove groups	DELETE	/interop/rest/security/<api_version>/groups
Remove groups status	GET	/interop/rest/security/<api_version>/jobs/<jobId>

Request

Supported Media Types: application/x-www-form-urlencoded

The following table summarizes the request parameters.

Table 12-54 Parameters

Name	Description	Type	Required	Default
api_version	Specific API version	Path	Yes	None
filename	The name of the uploaded ANSI or UTF-8 encoded CSV file containing information on the groups to be removed, for example, removeGroups.csv. The file must have been uploaded already using the Upload REST API. Group Name GroupA GroupB	Query	Yes	None

Response

Supported Media Types: application/json

Table 12-55 Parameters

Name	Description
details	In the case of errors, details are published with the error string
status	See Migration Status Codes
links	Detailed information about the link
href	Links to API call or status API
action	The HTTP call type
rel	Possible values: self or Job Status. If the value is set to Job Status, you can use the href to get the status
data	Parameters as key value pairs passed in the request
items	Details about the resource
links	Details of the first URL to be requested to get the job details; rel is "Job Details"

Examples of Resonse Body

The following examples show the contents of the response body in JSON format:

Example 1: Job is in Progress

{
    "status": -1,
    "items": null,
    "links": [
        {
            "href": " http://<BASE-URL>/interop/rest/security/<api_version>/groups?filename=<filename>",
            "rel": "self",
            "data": {
                "jobType": "REMOVE_GROUPS",
                "filename": "<filename>"
            },
            "action": "DELETE"
        },
        {
            "href": " http://<BASE-URL>/interop/rest/security/<api_version>/jobs/<jobId>",
            "rel": "Job Status",
            "data": null,
            "action": "GET"
        }
    ],
    "details": null
}

Example 2: Job Completes with Errors

{
    "links": [
        {
            "href": "http://<BASE-URL>/interop/rest/security/<api_version>/groups",
            "rel": "self",
            "data": {
                "jobType": "REMOVE_GROUPS",
                "filename": ""
            },
            "action": "DELETE"
        }
    ],
    "status": 1,
    "details": "EPMCSS-20673: Failed to delete groups. Invalid or insufficient parameters specified. Provide all required parameters for the REST API. ",
    "items": null
}

Example 3: Job Completes without Errors

{
    "links": [
        {
            "data": null,
            "action": "GET",
            "href": " http://<BASE-URL>/interop/rest/security/<api_version>/jobs/<jobId>",
            "rel": "self"
        }
    ],
    "status": 0,
    "details": "Processed - 3, Succeeded – 2, Failed - 1.   ",
    "items":  [
    {
		"GroupName":"<GROUPNAME>","Error_Details": "Group <GROUPNAME> is not found. Verify that the group exists."
     }
   ]
}

Java Sample Code

Prerequisites: json.jar

Common Functions: See CSS Common Helper Functions for Java

public void removeGroups(String fileName) {
		try {
			String url = this.serverUrl + "/interop/rest/security/" + apiVersion + "/groups";
			Map<String, String> reqHeaders = new HashMap<String, String>();
			reqHeaders.put("Authorization", "Basic " + DatatypeConverter
					.printBase64Binary((this.userName + ":" + this.password).getBytes(Charset.defaultCharset())));

			Map<String, String> reqParams = new HashMap<String, String>();
			reqParams.put("filename", fileName);

			Map<String, String> restResult = CSSRESTHelper.callRestApi(new HashMap(), url, reqHeaders, reqParams,
					"DELETE");
			String jobStatus = CSSRESTHelper.getCSSRESTJobCompletionStatus(restResult, reqHeaders);
			System.out.println(jobStatus);
		} catch (Exception e) {
			e.printStackTrace();
		}
	} 

Shell Script Sample Code

Prerequisites: jq (http://stedolan.github.io/jq/download/linux64/jq)

Common Functions: See CSS Common Helper Functions for cURL.

FuncRemoveGroups() {
        url="$SERVER_URL/interop/rest/security/$API_VERSION/groups"
        params="filename=$1"
        header="Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
        cssRESTAPI="removeGroups"
        statusMessage=$(funcCSSRESTHelper "DELETE" "$url" "$header" "$USERNAME" "$PASSWORD" "$params" "$cssRESTAPI")
        echo $statusMessage
}

Groovy Sample Code

Common Functions: See CSS Common Helper Functions for Groovy

def removeGroups(fileName) {

	String scenario = "Deleting Groups in " + fileName;
	String params = null;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/groups?filename=" + fileName);
	} catch (MalformedURLException e) {
		println "Please enter a valid URL"
		System.exit(0);
	}
	response = executeRequest(url, "DELETE", null, "application/x-www-form-urlencoded");
	if (response != null) {
		getJobStatus(getUrlFromResponse(scenario, response, "Job Status"), "GET");
	}
}

Common Functions

• See Common Helper Functions for Java

• See Common Helper Functions for cURL

• See CSS Common Helper Functions for Groovy