Validate Entitlement Request Data
POST/validateEntitlementRequestData
This API checks if a user is allowed to request for the entitlements given in a list based on the existing access and entitlement map exclusion.
The Authorization
must have Bearer
followed by Token
.
Mandatory params:
username
,
endpoint
,
entitlementList
- List of entitlementtypes and entitlements that needs to be checked.
Optional params:
includeinflightrequests
- If includeinflightrequests
is true, API will also consider Entitlement requests in flight (requests that are submitted but not yet approved/rejected).
Request
- application/json
Body
Array [
]
endpoint string
entitlementList
object[]
entitlementtype string
entitlementvalue string
includeinflightrequests string
username string
Responses
- 200
Validate Entitlement RequestData
Response Headers
Date
string
Server
string
Set-Cookie
string
- application/json
- Schema
- Example (from schema)
- Validate Entitlement RequestData
Schema
Array [
]
endpoint string
errorCode string
message string
username string
validationResults
object[]
entitlementtype string
entitlementvalue string
failurereason string
requestable string
{
"endpoint": "System1",
"errorCode": "1",
"message": "Failure",
"username": "188836",
"validationResults": [
{
"entitlementtype": "Access",
"entitlementvalue": "Analyst",
"requestable": "1"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Accountant",
"failurereason": "Entitlement already assigned to User",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Absence Calculations Administrator",
"failurereason": "Entitlement already requested",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Absence Partner",
"failurereason": "Excluded Entitlement for an Entitlement already requested",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "AM: Admin",
"failurereason": "Excluded Entitlement",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Action Plan Owner Group111",
"failurereason": "Invalid Entitlement",
"requestable": "0"
},
{
"entitlementtype": "Access111",
"entitlementvalue": "Action Plan Owner Group",
"failurereason": "Invalid Entitlement",
"requestable": "0"
}
]
}
{
"endpoint": "System1",
"errorCode": "1",
"message": "Failure",
"username": "188836",
"validationResults": [
{
"entitlementtype": "Access",
"entitlementvalue": "Analyst",
"requestable": "1"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Accountant",
"failurereason": "Entitlement already assigned to User",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Absence Calculations Administrator",
"failurereason": "Entitlement already requested",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Absence Partner",
"failurereason": "Excluded Entitlement for an Entitlement already requested",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "AM: Admin",
"failurereason": "Excluded Entitlement",
"requestable": "0"
},
{
"entitlementtype": "Access",
"entitlementvalue": "Action Plan Owner Group111",
"failurereason": "Invalid Entitlement",
"requestable": "0"
},
{
"entitlementtype": "Access111",
"entitlementvalue": "Action Plan Owner Group",
"failurereason": "Invalid Entitlement",
"requestable": "0"
}
]
}
Loading...