Jump to

• Request
• Response
• Examples

Fetch Role Mining Task Generated Candidate Roles

get

/oiri/api/v1/tasks/{taskId}/result

Request

Path Parameters

• taskId: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : RoleMiningResult

Type: object

Show Source

• candidateRoles(optional): array candidateRoles
• clusterConfig(optional): object clusterConfig
• jobId(optional): string
• status(optional): string

{
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "candidateRoles":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string"
                    },
                    "name":{
                        "type":"string"
                    },
                    "description":{
                        "type":"string"
                    },
                    "jobId":{
                        "type":"string"
                    },
                    "clusterId":{
                        "type":"number"
                    },
                    "status":{
                        "type":"string"
                    },
                    "publishedState":{
                        "type":"string"
                    },
                    "userCoverage":{
                        "type":"integer"
                    },
                    "entitlementCoverage":{
                        "type":"integer"
                    },
                    "userCount":{
                        "type":"number"
                    },
                    "entitlementCount":{
                        "type":"number"
                    },
                    "applicationCount":{
                        "type":"number"
                    },
                    "totalUserCount":{
                        "type":"number"
                    },
                    "totalEntCount":{
                        "type":"number"
                    },
                    "misalignedUserCount":{
                        "type":"number"
                    },
                    "misalignedEntCount":{
                        "type":"number"
                    },
                    "roleSimilarity":{
                        "type":"string"
                    },
                    "confidence":{
                        "type":"number"
                    },
                    "createdDate":{
                        "type":"string"
                    },
                    "createdBy":{
                        "type":"string"
                    },
                    "lastModifiedDate":{
                        "type":"string"
                    }
                }
            }
        },
        "clusterConfig":{
            "type":"object",
            "properties":{
                "similarAssignmentCount":{
                    "type":"integer"
                },
                "numberOfClusters":{
                    "type":"integer"
                },
                "numberOfIterations":{
                    "type":"integer"
                },
                "userCoveragePercentage":{
                    "type":"integer"
                },
                "entitlementCoveragePercentage":{
                    "type":"integer"
                }
            }
        }
    }
}

Nested Schema : candidateRoles

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "name":{
                "type":"string"
            },
            "description":{
                "type":"string"
            },
            "jobId":{
                "type":"string"
            },
            "clusterId":{
                "type":"number"
            },
            "status":{
                "type":"string"
            },
            "publishedState":{
                "type":"string"
            },
            "userCoverage":{
                "type":"integer"
            },
            "entitlementCoverage":{
                "type":"integer"
            },
            "userCount":{
                "type":"number"
            },
            "entitlementCount":{
                "type":"number"
            },
            "applicationCount":{
                "type":"number"
            },
            "totalUserCount":{
                "type":"number"
            },
            "totalEntCount":{
                "type":"number"
            },
            "misalignedUserCount":{
                "type":"number"
            },
            "misalignedEntCount":{
                "type":"number"
            },
            "roleSimilarity":{
                "type":"string"
            },
            "confidence":{
                "type":"number"
            },
            "createdDate":{
                "type":"string"
            },
            "createdBy":{
                "type":"string"
            },
            "lastModifiedDate":{
                "type":"string"
            }
        }
    }
}

Nested Schema : clusterConfig

Type: object

Show Source

• entitlementCoveragePercentage(optional): integer
• numberOfClusters(optional): integer
• numberOfIterations(optional): integer
• similarAssignmentCount(optional): integer
• userCoveragePercentage(optional): integer

{
    "type":"object",
    "properties":{
        "similarAssignmentCount":{
            "type":"integer"
        },
        "numberOfClusters":{
            "type":"integer"
        },
        "numberOfIterations":{
            "type":"integer"
        },
        "userCoveragePercentage":{
            "type":"integer"
        },
        "entitlementCoveragePercentage":{
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "clusterId":{
            "type":"number"
        },
        "status":{
            "type":"string"
        },
        "publishedState":{
            "type":"string"
        },
        "userCoverage":{
            "type":"integer"
        },
        "entitlementCoverage":{
            "type":"integer"
        },
        "userCount":{
            "type":"number"
        },
        "entitlementCount":{
            "type":"number"
        },
        "applicationCount":{
            "type":"number"
        },
        "totalUserCount":{
            "type":"number"
        },
        "totalEntCount":{
            "type":"number"
        },
        "misalignedUserCount":{
            "type":"number"
        },
        "misalignedEntCount":{
            "type":"number"
        },
        "roleSimilarity":{
            "type":"string"
        },
        "confidence":{
            "type":"number"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string"
        }
    }
}

Back to Top

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
}

Back to Top