Skip to main content

Get Entitlements

POST 
/getEntitlements

This API can be used to get the list of all the entitlements.

This API call can be used to get the list and details of all the entitlements the user has access to.

This API will return only the entitlement attributes which are not null or not empty.

The Authorization must have Bearer followed by Token.

Optional params: username, entitlementtype, endpoint, requestedObject -"users","userscount", max, offset, entitlementResponseFields, userResponseFields, userfiltercriteria, accountname, entownerwithrank - if "true", returns the list of owners with owner rank for every entitlementValue, returnentitlementmap(true/false,default:false) - If true, entitlementmap details will be returned, exactmatch - Default is true. If given as false, it will search based on similar matches,

entitlementfiltercriteria,

OR

entQuery - query to support only entitlement_values parameters. Sample - "ent.description = 'Desc' or ent.displayname like '%display%'".

Note - Either pass param entitlementfiltercriteria (with or without exactmatch) OR entQuery. Both cannot be passed simultaneously.

Request​

Path Parameters

    path stringrequired

Body

    endpoint string
    entQuery string
    entownerwithrank string
    returnentitlementmap string
    username string

Responses​

Get Entitlements / Get Entitlements

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Pragma

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • Transfer-Encoding

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

  • X-XSS-Protection

    string

Schema

    Entitlementdetails

    object[]

  • Array [

    • accounts

    object[]

  • Array [

    • accountname string
    enddate string
    startdate string
    updatedate string

  • ]

    • childEntitlementCount number
    customproperty1 string
    customproperty10 string
    customproperty13 string
    customproperty15 string
    customproperty16 string
    customproperty17 string
    customproperty18 string
    customproperty19 string
    customproperty2 string
    customproperty20 string
    customproperty3 string
    customproperty4 string
    customproperty5 string
    customproperty6 string
    customproperty7 string
    customproperty8 string
    customproperty9 string
    description string
    displayname string
    endpoint string
    endpointKey number
    entitlementID string

    entitlementMapDetails

    object[]

  • Array [

    • addDependentTask string
    description string
    excludeEntitlement string
    exportPrimary string
    primary string
    primaryEntKey string
    primaryEntType string
    removeDependentEntTask string
    requestFilter string

  • ]

    • entitlementOwner string
    entitlementType string
    entitlementTypeKey number
    entitlementTypeName string
    entitlement_glossary string
    entitlement_value string
    entitlement_valuekey string
    requestForm string
    soxcritical string
    status string
    syscritical string
    updatedate string

  • ]

    • entitlementsCount number
    errorCode string
    msg string
    totalEntitlementCount number
Loading...