REST APIs for Oracle Identity Role Intelligence

List candidate roles misaligned entitlement users

get

/oiri/api/v1/tasks/{taskId}/candidate-roles/{candidateRoleId}/misaligned-entitlements/{entitlementId}/users

Request

Path Parameters

candidateRoleId: string
entitlementId: string
taskId: string

Query Parameters

limit: integer(int32)
offset: integer(int32)
sortBy: string
sortOrder: string

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : CandidateRoleUserResponse

Type: object

Show Source

data(optional): array data
recordCount(optional): integer

{
    "properties":{
        "recordCount":{
            "type":"integer"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UserDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object UserDTO

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

Nested Schema : UserDTO

Type: object

Show Source

customAttributes(optional): object customAttributes
departmentNumber(optional): string
employeeNumber(optional): string
employeeType(optional): string
jobCode(optional): string
managerDisplayName(optional): string
managerName(optional): string
misalignedCount(optional): integer
organizationName(optional): string
usage(optional): number
userDisplayName(optional): string
userKey(optional): string
userName(optional): string

{
    "properties":{
        "userKey":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "employeeType":{
            "type":"string"
        },
        "jobCode":{
            "type":"string"
        },
        "managerName":{
            "type":"string"
        },
        "organizationName":{
            "type":"string"
        },
        "usage":{
            "type":"number"
        },
        "userDisplayName":{
            "type":"string"
        },
        "managerDisplayName":{
            "type":"string"
        },
        "employeeNumber":{
            "type":"string"
        },
        "departmentNumber":{
            "type":"string"
        },
        "misalignedCount":{
            "type":"integer"
        },
        "customAttributes":{
            "properties":{
                "map":{
                    "type":"object",
                    "properties":{
                        "value":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : customAttributes

Type: object

Show Source

map(optional): object map

{
    "properties":{
        "map":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : map

Type: object

Show Source

value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Examples

The following example shows how to list misaligned entitlement users for candidate roles.

curl -X GET\
-H "Accept: application/json"\
-H "Authorization: Bearer $token"\
"http://localhost:port/oiri/api/v1/tasks/70561adbfdd7474290b77d5903210c6b/candidate-roles/97d40d053dd74a45a6e944f45cbfae6a/misaligned-entitlements/G3001/users"

Example of the Response Body

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

{
"recordCount": 2,
"data": [
{
"entitlementKey": "G141",
"entitlementDisplayName": "CN=adbienta11,OU=grps,OU=ganesh_bi_test,DC=adlrg12c,DC=us,DC=oracle,DC=com",
"applicationName": "BoKS_QA_latest",
"usage": null,
"misalignedCount": null,
"extEntitlementId": null
},
{
"entitlementKey": "G142",
"entitlementDisplayName": "CN=adbienta12,OU=grps,OU=ganesh_bi_test,DC=adlrg12c,DC=us,DC=oracle,DC=com",
"applicationName": "BoKS_QA_latest",
"usage": null,
"misalignedCount": null,
"extEntitlementId": null
}
]
}