Run Role Mining Task To Discovery Roles
post
/oiri/api/v1/tasks/{taskId}/.run
Run job by changing status to READY if in status 'CREATED'
Request
Path Parameters
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : JobDetails
Type:
Show Source
object-
createdBy(optional):
string
-
createdDate(optional):
string
-
description(optional):
string
-
finishedData(optional):
string
-
id(optional):
string
-
input(optional):
object input
-
lastUpdatedDate(optional):
string
-
message(optional):
string
-
name(optional):
string
-
output(optional):
string
-
sourceId(optional):
string
-
sourceName(optional):
string
-
startedDate(optional):
string
-
status(optional):
string
-
type(optional):
string
Examples
The following example shows how to run a role mining task to discover roles.
curl -X POST\ -H "Accept: application/json"\ -H "Content-Type: application/json"\ -H "Authorization: Bearer $token"\ "http://localhost:port/oiri/api/v1/tasks/2/.run" -d
Example of the Request Body
The following is an example of the request body in JSON format.
{
"candidateRolePrefix":"Ab",
"candidateRoleCountIndicator":3
}
Example of the Response Body
The following is an example of the response body in JSON format.
{
"id": "2",
"sourceId": null,
"sourceName": null,
"name": "SampleTask2",
"description": "SampleTask2",
"type": "ROLE_MINING",
"status": "READY",
"message": null,
"createdDate": "2021-04-22T07:12:31.436679Z",
"createdBy": "RFROST",
"lastUpdatedDate": "2021-04-22T12:42:44.061188Z",
"startedDate": null,
"finishedData": null,
"input": {
"name": "SampleTask2",
"description": "SampleTask2",
"candidateRolePrefix": "Ab",
"criteria": [
{
"type": "user",
"filter": "organization in (\"StarOrg1\",\"MyOrg1\")"
}
],
"candidateRoleCountIndicator": 3
},
"output": null
}