Removing Users from a Team for Account Reconciliation

Removes Oracle Enterprise Performance Management Cloud users listed in a UTF8 formatted CSV file from an existing team in Access Control for Account Reconciliation. The file must be uploaded to the environment before using this API, and the file should be deleted after the API executes. Use the Upload REST API to upload the file.

A primary user is, by default, designated to perform the tasks that are assigned to the team. The file format is as follows:

User Login, primary_user
jdoe, yes
jane.doe@example.com,no

Note: The users are removed only if both these conditions are met:

User login IDs included in the file exist in the identity domain that services the environment
The user is assigned to a pre-defined role in the identity domain

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

REST Resource

POST /armARCS/rest/{version}/jobs

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.

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/armARCS/rest/v1/jobs/

Required Roles

Service Administrator

Request

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

Example of Request Body

The following table summarizes the parameters of the JSON request.

Table 12-95 Parameters

Name	Data type	Description
`version`	String	The version of the API you are developing with. For the current release, the version is v1.
`jobName`	String	The name of the job, `REMOVE_USERS_FROM_TEAM`.
`fileName`	String	The name of the uploaded ANSI or UTF-8 encoded CSV file containing information on the users to be remved, for example, `removeUsersFromTeam.csv`. The file must have been uploaded already using the Upload REST API. The CSV file should not include the account of the user who executes this command. A primary user is, by default, designated to perform the tasks that are assigned to the team. The file format is as follows: `User Login, primary_user jdoe, yes jane.doe@example.com,no`
`teamName`	String	The name of an existing team in Access Control, such as `Team1`

Example of Request Body

{
   "jobName":"REMOVE_USERS_FROM_TEAM",
   "parameters":{
      "fileName":"users.csv",
      "teamName":"Team1"
   }
}

Response

Supported Media Types: application/json

Parameters

Table 12-96 Parameters

Name	Description
`type`	Application type
`status`	`-1` - In Progress `0` - Success `1` - Failure
`details`	In case of errors, details are published with the error string
`descriptiveStatus`	The status of the job, such as `Completed` or `Error`.
`items`	Collection of notification categories
`links`	Detailed information about the link
`href`	Links to the API call
`action`	The HTTP call type
`rel`	Possible value: `self`
`data`	Parameters as key value pairs passed in the request

Example of Response Body

The following is an example of the response body in JSON format.

{
  "details": "In Process",
  "links": [
    {
      "rel": "self",
      "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<dcX>.oraclecloud.com/armARCS/rest/v1/jobs/100000000053010",
      "action": "GET"
    }
  ],
  "status": -1,
  "type": "ARCS",
  "link": null,
  "items": null,
  "error": null
}

Common Functions