Jump to

• Request
• Response
• Examples

List misaligned entitlements in a candidate role

get

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

Request

Path Parameters

• candidateRoleId: string
• taskId: string

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• page(optional): object page
• recordCount(optional): integer
• searchFilters(optional): string
• sort(optional): object sort

{
    "properties":{
        "page":{
            "required":[
                "offset",
                "limit"
            ],
            "properties":{
                "offset":{
                    "type":"number"
                },
                "limit":{
                    "type":"number"
                }
            },
            "type":"object"
        },
        "sort":{
            "required":[
                "sortBy",
                "sortOrder"
            ],
            "properties":{
                "sortBy":{
                    "type":"string"
                },
                "sortOrder":{
                    "type":"string"
                }
            },
            "type":"object"
        },
        "searchFilters":{
            "type":"string"
        },
        "recordCount":{
            "type":"integer"
        }
    }
}

Nested Schema : page

Type: object

Show Source

• limit: number
• offset: number

{
    "required":[
        "offset",
        "limit"
    ],
    "properties":{
        "offset":{
            "type":"number"
        },
        "limit":{
            "type":"number"
        }
    },
    "type":"object"
}

Nested Schema : sort

Type: object

Show Source

• sortBy: string
• sortOrder: string

{
    "required":[
        "sortBy",
        "sortOrder"
    ],
    "properties":{
        "sortBy":{
            "type":"string"
        },
        "sortOrder":{
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : CandidateRoleEntitlementResponse

Type: object

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object EntitlementDTO

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

Nested Schema : EntitlementDTO

Type: object

Show Source

• applicationName(optional): string
• entitlementDisplayName(optional): string
• entitlementKey(optional): string
• misalignedCount(optional): integer
• usage(optional): number

{
    "properties":{
        "entitlementKey":{
            "type":"string"
        },
        "entitlementDisplayName":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "usage":{
            "type":"number"
        },
        "misalignedCount":{
            "type":"integer"
        }
    }
}

Back to Top

Examples

The following example shows how to list misaligned entitlements in a candidate role.

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

Example of the Response Body

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

{
"limit": 5,
"offset": 0,
"recordCount": 5,
"count": 5,
"hasMore": false,
"items": [
{
"entitlementKey": "G206",
"entitlementDisplayName": "Users",
"applicationName": "JIRA",
"usage": null,
"misalignedCount": 1,
"extEntitlementId": null
},
{
"entitlementKey": "G184",
"entitlementDisplayName": "Thosiba",
"applicationName": "Corp Laptop",
"usage": null,
"misalignedCount": 1,
"extEntitlementId": null
},
{
"entitlementKey": "G202",
"entitlementDisplayName": "Guest",
"applicationName": "Orahub",
"usage": null,
"misalignedCount": 2,
"extEntitlementId": null
},
{
"entitlementKey": "G142",
"entitlementDisplayName": "CN=adbienta12,OU=grps,OU=robert_bi_test,DC=host123,DC=us,DC=example,DC=com",
"applicationName": "BoKS_QA_latest",
"usage": null,
"misalignedCount": 1,
"extEntitlementId": null
},
{
"entitlementKey": "G141",
"entitlementDisplayName": "CN=adbienta11,OU=grps,OU=robert_bi_test,DC=host123,DC=us,DC=example,DC=com",
"applicationName": "BoKS_QA_latest",
"usage": null,
"misalignedCount": 1,
"extEntitlementId": null
}
]
}

Back to Top