Remove Users from an Identity Domain

Deletes the identity domain accounts identified in an ANSI or UTF-8 encoded CSV file that was uploaded to the environment. Before running this command, use the Upload REST API to upload the file. The file format is as follows:

User Login
jane.doe@example.com
jdoe@example.com

This API should be run only by Service Administrators who are also assigned to the Identity Domain Administrator role in the identity domain from which users are to be removed. The CSV file should not include the account of the user who executes this command. Because user accounts are common to all service environments that an Identity Domain Administrator supports, deleting an account for one environment deletes it for all environments that share the Identity Domain Administrator.

\

The API is asynchronous and returns the Job ID. The presence of status -1 in the response indicates that the removal of users is in progress. Use the job status URI to determine whether the removal of users is complete. Any non-zero status except -1 indicates failure of removing users.

This API is version v1.

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See About the REST APIs. Using these REST APIs requires prerequisites. See Prerequisites.

Table 8-5 Tasks for Remove Users

Task Request REST Resource
Remove users DELETE /interop/rest/security/users?filename=<filename>
Remove users status GET /interop/rest/security/<api_version>/jobs/

REST Resource

DELETE /interop/rest/security/users?filename=<filename>

Supported Media Types: application/json

Parameters:

The following table summarizes the DELETE request parameters.

Table 8-6 Parameters

Name Description Type Required Default
filename

The name of the uploaded ANSI or UTF-8 encoded CSV file name of a CSV file containing the login names of the users to be removed from a group maintained in Access Control, for example, removeUsers.csv.

Form Yes None

Response

Supported Media Types: application/json

Parameters:

Table 8-7 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 of the recreate service
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"

Example of Response Body in JSON format

Example 1: Response when the job is in progress

{
  "links": [
    {
      "rel": "self",
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/security/<api_version>/users?filename=<filename>",
      "data": {
        "jobType": "REMOVE_USERS",
        "filename": "<filename>"
      },
      "action": "DELETE"
    },
    {
      "rel": "Job Status",
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/security/<api_version>/jobs/",
      "data": null,
      "action": "GET"
    }
  ],
  "details": null,
  "status": -1,
  "items": null
}

Example 2: Response when the job completes with errors

{
  "links": [
    {
      "rel": "self",
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>..oraclecloud.com/interop/rest/security/<api_version>/jobs/",
      "data": null,
      "action": "GET"
    }
  ],
  "details": "Failed to remove users. File <filename> is not found. Please provide a valid file name.",
  "status": 1,
  "items": null
}

Example 3: Response when the job completes with no errors

{
  "links": [
    {
      "rel": "self",
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>..oraclecloud.com/interop/rest/security/<api_version>/jobs/",
      "data": null,
      "action": "GET"
    }
  ],
  "details": "Processed - 3, Succeeded - 1, Failed - 2.",
  "status": 0,
  "items": null
}

Example 8-1 Java Sample Code

Prerequisites: json.jar

Common Functions: See CSS Common Helper Functions for Java.

public void removeUsers(String fileName) {
		try {
			String url = this.serverUrl + "/interop/rest/security/" + apiVersion + "/users";
			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();
		}
	}

Example 8-2 Shell Script Sample Code

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

Common Functions: See CSS Common Helper Functions for cURL.

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

Groovy Sample Code

CSS Common Helper Functions for Groovy.

def deleteUsers(fileName) {

	String scenario = "Deleting users in " + fileName;
	String params = null;
	def url = null;
	def response = null;
	try {
		url = new URL(serverUrl + "/interop/rest/security/" + apiVersion + "/users?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");
	}
}