Get User Requestable Entitlements

POST 
/getUserRequestableEntitlements

This API returns list of entitlements in an application that the user can request based on the existing access and entitlement map exclusion.

The Authorization must have Bearer followed by Token.

Mandatory params: username, endpointname

Optional params:

max,offset

entitlementtype,

entitlementResponseFields - Entitlement_value attributes required in the reponse,

endpointResponseFields - Endpoint attributes required in the response,

includeinflightrequests - If includeinflightrequests is true, API will also consider Entitlement requests in flight (requests that are submitted but not yet approved/rejected),

allowAssignedEntitlement - if allowAssignedEntitlement is true, API will consider the entitlements (and excluded entitlements) that are assigned to the user as requestable.

Request

application/json

Body

endpointstring
Example: System1
endpointResponseFieldsstring[]
Example: ["customproperty5","securitysystem","description","displayName"]
entitlementResponseFieldsstring[]
Example: ["customproperty1","access","status"]
entitlementtypestring
Example: Access
includeinflightrequestsstring
Example: true
usernamestring
Example: 188837

Responses

200

Get User Requestable Entitlements

Response Headers

• Date

  string

• Server

  string

• Set-Cookie

  string

application/json

Schema

Schema

countofEntitlementsnumber
Example: 1215

endpointDetails

object[]

Array [

customproperty5string

Example: true

displayNamestring

Example: System1-DisplayName

securitysystemstring

Example: System1

]

entitlementDetails

object[]

Array [

accessstring

Example: Select

customproperty1string

Example: test

entitlementTypestring

Example: Access

entitlement_valuestring

Example: Analyst

requestablestring

Example: 1

statusstring

Example: 1

]

errorCodestring
Example: 0
messagestring
Example: SUCCESS

Example (from schema)

{
  "countofEntitlements": 1215,
  "endpointDetails": [
    {
      "customproperty5": "true",
      "displayName": "System1-DisplayName",
      "securitysystem": "System1"
    }
  ],
  "entitlementDetails": [
    {
      "access": "Select",
      "customproperty1": "test",
      "entitlementType": "Access",
      "entitlement_value": "Analyst",
      "requestable": "1",
      "status": "1"
    },
    {
      "access": "Select",
      "customproperty1": "test",
      "entitlementType": "Access",
      "entitlement_value": "Absence Administrator",
      "requestable": "1",
      "status": "1"
    },
    {
      "access": "Select",
      "customproperty1": "test",
      "entitlementType": "Access",
      "entitlement_value": "Absence Calculations Administrator",
      "requestable": "1",
      "status": "1"
    },
    {
      "customproperty1": "Eng",
      "entitlementType": "Access",
      "entitlement_value": "Absence Partner",
      "requestable": "1",
      "status": "1"
    },
    {
      "customproperty1": "Eng",
      "entitlementType": "Access",
      "entitlement_value": "Accountant",
      "requestable": "0",
      "status": "1"
    },
    {
      "customproperty1": "Eng",
      "entitlementType": "Access",
      "entitlement_value": "AccountantTwo",
      "requestable": "1",
      "status": "1"
    }
  ],
  "errorCode": "0",
  "message": "SUCCESS"
}

Get User Requestable Entitlements

{
  "countofEntitlements": 1215,
  "endpointDetails": [
    {
      "customproperty5": "true",
      "displayName": "System1-DisplayName",
      "securitysystem": "System1"
    }
  ],
  "entitlementDetails": [
    {
      "access": "Select",
      "customproperty1": "test",
      "entitlementType": "Access",
      "entitlement_value": "Analyst",
      "requestable": "1",
      "status": "1"
    },
    {
      "access": "Select",
      "customproperty1": "test",
      "entitlementType": "Access",
      "entitlement_value": "Absence Administrator",
      "requestable": "1",
      "status": "1"
    },
    {
      "access": "Select",
      "customproperty1": "test",
      "entitlementType": "Access",
      "entitlement_value": "Absence Calculations Administrator",
      "requestable": "1",
      "status": "1"
    },
    {
      "customproperty1": "Eng",
      "entitlementType": "Access",
      "entitlement_value": "Absence Partner",
      "requestable": "1",
      "status": "1"
    },
    {
      "customproperty1": "Eng",
      "entitlementType": "Access",
      "entitlement_value": "Accountant",
      "requestable": "0",
      "status": "1"
    },
    {
      "customproperty1": "Eng",
      "entitlementType": "Access",
      "entitlement_value": "AccountantTwo",
      "requestable": "1",
      "status": "1"
    }
  ],
  "errorCode": "0",
  "message": "SUCCESS"
}