Skip to main content

Validate Entitlement Request Data

POST 
https://example.saviyntcloud.com/ECM/api/v5/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​

Body

    endpointstring
    Example: System1

    entitlementList

    object[]

  • Array [

    • entitlementtypestring
    Example: Access
    entitlementvaluestring
    Example: Analyst

  • ]

    • includeinflightrequestsstring
    Example: true
    usernamestring
    Example: 188836

Responses​

Validate Entitlement RequestData

Response Headers

  • Date

    string

  • Server

    string

  • Set-Cookie

    string

Schema

    endpointstring
    Example: System1
    errorCodestring
    Example: 1
    messagestring
    Example: Failure
    usernamestring
    Example: 188836

    validationResults

    object[]

  • Array [

    • entitlementtypestring
    Example: Access
    entitlementvaluestring
    Example: Analyst
    failurereasonstring
    Example: Entitlement already assigned to User
    requestablestring
    Example: 1

  • ]

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWT
curl -L 'https://example.saviyntcloud.com/ECM/api/v5/validateEntitlementRequestData' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "endpoint": "System1",
  "entitlementList": [
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Analyst"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Accountant"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Absence Calculations Administrator"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Absence Partner"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "AM: Admin"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Action Plan Owner Group111"
    },
    {
      "entitlementtype": "Access111",
      "entitlementvalue": "Action Plan Owner Group"
    }
  ],
  "includeinflightrequests": "true",
  "username": "188836"
}'
Request Collapse all
Base URL
https://example.saviyntcloud.com/ECM/api/v5
Auth
Body
{
  "endpoint": "System1",
  "entitlementList": [
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Analyst"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Accountant"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Absence Calculations Administrator"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Absence Partner"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "AM: Admin"
    },
    {
      "entitlementtype": "Access",
      "entitlementvalue": "Action Plan Owner Group111"
    },
    {
      "entitlementtype": "Access111",
      "entitlementvalue": "Action Plan Owner Group"
    }
  ],
  "includeinflightrequests": "true",
  "username": "188836"
}
ResponseClear

Click the Send API Request button above and see the response here!