Fetch Role Mining Task Generated Candidate Roles
get
/oiri/api/v1/tasks/{taskId}/result
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Nested Schema : items
Type:
Show Source
object-
applicationCount(optional):
number
-
clusterId(optional):
number
-
confidence(optional):
number
-
createdBy(optional):
string
-
createdDate(optional):
string
-
description(optional):
string
-
entitlementCount(optional):
number
-
entitlementCoverage(optional):
integer
-
id(optional):
string
-
jobId(optional):
string
-
lastModifiedDate(optional):
string
-
misalignedEntCount(optional):
number
-
misalignedUserCount(optional):
number
-
name(optional):
string
-
publishedState(optional):
string
-
roleSimilarity(optional):
string
-
status(optional):
string
-
totalEntCount(optional):
number
-
totalUserCount(optional):
number
-
userCount(optional):
number
-
userCoverage(optional):
integer
Examples
The following example shows how to update a nonexecuted role mining task.
curl -X PUT\ -H "Accept: application/json"\ -H "Content-Type: application/json"\ -H "Authorization: Bearer $token"\ "http://localhost:port/oiri/api/v1/tasks/2" -d
Example of the Request Body
The following is an example of the request body in JSON format.
{
"name":"SampleTask2",
"description":"SampleTask2",
"criteria":
[{"type":"user",
"filter":"organization in (\"StarOrg1\",\"MyOrg1\")"}],
"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": "CREATED",
"message": null,
"createdDate": "2021-04-22T07:12:31.436679Z",
"createdBy": "RFROST",
"lastUpdatedDate": "2021-04-22T12:38:10.713501Z",
"startedDate": null,
"finishedData": null,
"input": {
"name": "SampleTask2",
"description": "SampleTask2",
"candidateRolePrefix": "",
"criteria": [
{
"type": "user",
"filter": "organization in (\"StarOrg1\",\"MyOrg1\")"
}
],
"candidateRoleCountIndicator": 3
},
"output": null
}