Jump to

• Request
• Response
• Examples

Create And Run Role Mining Task To Discovery Roles

post

/oiri/api/v1/tasks/.discoverRoles

Create a job with Status=READY, sourceID and sourceName as null.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• candidateRoleCountIndicator(optional): integer
• candidateRolePrefix(optional): string
• criteria(optional): array criteria
• description(optional): string
• name(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "candidateRolePrefix":{
            "type":"string"
        },
        "criteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Criteria"
            }
        },
        "candidateRoleCountIndicator":{
            "type":"integer"
        }
    }
}

Nested Schema : criteria

Type: array

Show Source

• Array of: object Criteria

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Criteria"
    }
}

Nested Schema : Criteria

Type: object

Show Source

• filter(optional): string
• type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        },
        "filter":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : JobDetails

Type: object

Show Source

• 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

{
    "properties":{
        "id":{
            "type":"string"
        },
        "sourceId":{
            "type":"string"
        },
        "sourceName":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string"
        },
        "startedDate":{
            "type":"string"
        },
        "finishedData":{
            "type":"string"
        },
        "input":{
            "properties":{
                "name":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "candidateRolePrefix":{
                    "type":"string"
                },
                "criteria":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Criteria"
                    }
                },
                "candidateRoleCountIndicator":{
                    "type":"integer"
                }
            },
            "type":"object"
        },
        "output":{
            "type":"string"
        }
    }
}

Nested Schema : input

Type: object

Show Source

• candidateRoleCountIndicator(optional): integer
• candidateRolePrefix(optional): string
• criteria(optional): array criteria
• description(optional): string
• name(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "candidateRolePrefix":{
            "type":"string"
        },
        "criteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Criteria"
            }
        },
        "candidateRoleCountIndicator":{
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : criteria

Type: array

Show Source

• Array of: object Criteria

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Criteria"
    }
}

Nested Schema : Criteria

Type: object

Show Source

• filter(optional): string
• type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        },
        "filter":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to create and run a role mining task to discover candidate roles.

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/.discoverRoles" -d

Example of the Request Body

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

{
 name: "SampleTask",
 description: "SampleTask desc",
 criteria: [{type: "user", filter: "organization in (\"VisCertOrg\")"}],
 candidateRoleCountIndicator: 3,
 candidateRolePrefix: "cr"
}

Example of the Response Body

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

{
"id": "1",
"sourceId": null,
"sourceName": null,
"name": "SampleTask",
"description": "SampleTask desc",
"type": "ROLE_MINING",
"status": "READY",
"message": null,
"createdDate": "2021-04-21T09:50:41.782279Z",
"createdBy": "RFROST",
"lastUpdatedDate": "2021-04-21T09:50:41.782279Z",
"startedDate": null,
"finishedData": null,
"input": {
"name": "SampleTask",
"description": "SampleTask desc",
"candidateRolePrefix": "cr",
"criteria": [
{
"type": "user",
"filter": "organization in (\"VisCertOrg\")"
}
],
"candidateRoleCountIndicator": 3
},
"output": null
}

Back to Top