Search Role Mining Tasks Based On Criteria
post
/oiri/api/v1/tasks/.search
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
request for role mining tasks search
Response
Supported Media Types
- application/json
200 Response
OK
Nested Schema : items
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
-
name(optional):
string
-
output(optional):
object output
-
startedDate(optional):
string
-
status(optional):
string
-
type(optional):
string
Nested Schema : items
Type:
Show Source
object-
applicationCount(optional):
number
-
clusterId(optional):
number
-
confidence(optional):
number
-
description(optional):
string
-
entitlementCount(optional):
number
-
entitlementCoverage(optional):
integer
-
jobId(optional):
string
-
misalignedEntCount(optional):
number
-
misalignedUserCount(optional):
number
-
name(optional):
string
-
roleSimilarity(optional):
string
-
totalEntCount(optional):
number
-
totalUserCount(optional):
number
-
userCount(optional):
number
-
userCoverage(optional):
integer
Examples
The following example shows how to search for role mining tasks based on criteria.
curl -X POST\ -H "Accept: application/json"\ -H "Content-Type: application/json"\ -H "Authorization: Bearer $token"\ "http://localhost:port/oiri/api/v1/tasks/.search" -d
Example of the Request Body
The following is an example of the request body.
{
"page":
{"offset":0,
"limit":10},
"sort":
{"sortBy":"createdDate",
"sortOrder":"DESC"},
"searchFilters": "status in (\"CREATED\")"
}
Example of the Response Body
The following is an example of the response body in JSON format.
{
"recordCount": 1,
"jobs": [
{
"id": "2",
"sourceId": null,
"sourceName": null,
"name": "SampleTask2",
"description": "SampleTask2 desc",
"type": "ROLE_MINING",
"status": "CREATED",
"message": null,
"createdDate": "2021-04-22T07:12:31.436679Z",
"createdBy": "RFROST",
"lastUpdatedDate": "2021-04-22T07:12:31.436679Z",
"startedDate": null,
"finishedData": null,
"input": {
"name": "SampleTask2",
"description": "SampleTask2 desc",
"candidateRolePrefix": "cr",
"criteria": [
{
"type": "user",
"filter": "organization in (\"VisCertOrg\")"
}
],
"candidateRoleCountIndicator": 3
},
"output": null
}
],
"limit": 10,
"offset": 0,
"count": 1,
"hasMore": false
}