Get List of Entitlement Types

GET 
/getEntitlementTypes

This API returns list of Entitlement Types in SSM. The Authorization must have Bearer followed by Token. Optional params: entitlementname, max, offset, endpointname

Request

Query Parameters

entitlementname string
max string
offset string
endpointname string

Responses

200

Get Entitlement Types

Response Headers

• Date

  string

• Server

  string

• Set-Cookie

  string

• X-Content-Type-Options

  string

application/json

Schema

Schema

displayCountnumber
Example: 1

entitlementTypeDetails

object[]

Array [

ars_req_ent_sqlquereystring

Example: ev.status=1 and ev.customproperty1='TRUE'

ars_select_ent_sqlquereystring

Example: testsel

availableQueryServiceAccountstring

Example: test qry

certifiablestring

Example: true

createTaskActionstring

Example: {"taskActions":["enableRollback","removeTaskForExistingEntitlements","noAction"]}

customproperty1_labelstring

Example: cp1

customproperty9_labelstring

Example: cp9

displayNamestring

Example: testEnt81

endpointstring

Example: AD Test

entitlementdescriptionstring

Example: entitlementdescription

entitlementnamestring

Example: testEnt81

hiearchyrequiredstring

Example: 0

orderindexstring

Example: 2

reconstring

Example: true

requestDatesConfJsonstring

Example: test date

requestoptionstring

Example: Request Form Table No Remove

requiredinrequeststring

Example: false

securitysystemstring

Example: AD Test

selectedQueryServiceAccountstring

Example: service acc qry

showonchildstring

Example: false

workflowstring

Example: SampleManagerApproval

]

errorCodestring
Example: 0
msgstring
Example: Success
totalCountnumber
Example: 1

Example (from schema)

{
  "displayCount": 1,
  "entitlementTypeDetails": [
    {
      "ars_req_ent_sqlquerey": "ev.status=1 and ev.customproperty1='TRUE'",
      "ars_select_ent_sqlquerey": "testsel",
      "availableQueryServiceAccount": "test qry",
      "certifiable": "true",
      "createTaskAction": "{\"taskActions\":[\"enableRollback\",\"removeTaskForExistingEntitlements\",\"noAction\"]}",
      "customproperty1_label": "cp1",
      "customproperty9_label": "cp9",
      "displayName": "testEnt81",
      "endpoint": "AD Test",
      "entitlementdescription": "entitlementdescription",
      "entitlementname": "testEnt81",
      "hiearchyrequired": "0",
      "orderindex": "2",
      "recon": "true",
      "requestDatesConfJson": "test date",
      "requestoption": "Request Form Table No Remove",
      "requiredinrequest": "false",
      "securitysystem": "AD Test",
      "selectedQueryServiceAccount": "service acc qry",
      "showonchild": "false",
      "workflow": "SampleManagerApproval"
    }
  ],
  "errorCode": "0",
  "msg": "Success",
  "totalCount": 1
}

Get Entitlement Types

{
  "displayCount": 1,
  "entitlementTypeDetails": [
    {
      "ars_req_ent_sqlquerey": "ev.status=1 and ev.customproperty1='TRUE'",
      "ars_select_ent_sqlquerey": "testsel",
      "availableQueryServiceAccount": "test qry",
      "certifiable": "true",
      "createTaskAction": "{\"taskActions\":[\"enableRollback\",\"removeTaskForExistingEntitlements\",\"noAction\"]}",
      "customproperty1_label": "cp1",
      "customproperty9_label": "cp9",
      "displayName": "testEnt81",
      "endpoint": "AD Test",
      "entitlementdescription": "entitlementdescription",
      "entitlementname": "testEnt81",
      "hiearchyrequired": "0",
      "orderindex": "2",
      "recon": "true",
      "requestDatesConfJson": "test date",
      "requestoption": "Request Form Table No Remove",
      "requiredinrequest": "false",
      "securitysystem": "AD Test",
      "selectedQueryServiceAccount": "service acc qry",
      "showonchild": "false",
      "workflow": "SampleManagerApproval"
    }
  ],
  "errorCode": "0",
  "msg": "Success",
  "totalCount": 1
}