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​

Body

    endpointstring
    Example: AWS
    entQuerystring
    Example: ent.entitlement_value like '%i-03d58cd60fa90b9a9%'
    entownerwithrankstring
    Example: true
    returnentitlementmapstring
    Example: true
    usernamestring
    Example: jasorodriguez

Responses​

Get Entitlements / Get Entitlements

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

Schema

    Entitlementdetails

    object[]

  • Array [

    • accounts

    object[]

  • Array [

    • accountnamestring
    Example: jasorodriguez
    enddatestring
    Example:
    startdatestring
    Example:
    updatedatestring
    Example:

  • ]

    • childEntitlementCountnumber
    Example: 0
    customproperty1string
    Example: Code: 80,Name: stopped
    customproperty10string
    Example: false
    customproperty13string
    Example: N
    customproperty15string
    Example: 2017-07-03 17:10:15
    customproperty16string
    Example: State: disabled
    customproperty17string
    Example: ami-0c2dfb1a
    customproperty18string
    Example: AWSSaviynt-6612acc
    customproperty19string
    Example: default
    customproperty2string
    Example: m3.xlarge
    customproperty20string
    Example: ip-172-31-19-127.ec2.internal
    customproperty3string
    Example: Key: Owner,Value: Sagar Srikantaiah, Key: aws:cloudformation:stack-id,Value: arn:aws:cloudformation:us-east-1:661222050851:stack/IDMAMITest/b8c82f20-f8a8-11e6-845b-500c28903236, Key: aws:cloudformation:logical-id,Value: SaviyntAWSEC2, Key: Name,Value: IDMAMITest, Key: aws:cloudformation:stack-name,Value: IDMAMITest
    customproperty4string
    Example: 172.31.19.127
    customproperty5string
    Example: vpc-60389904
    customproperty6string
    Example: subnet-3e9ea667
    customproperty7string
    Example: false
    customproperty8string
    Example: Arn: arn:aws:iam::661222050851:instance-profile/IDMAMITest-SaviyntAWSInstanceProfile-PB8FBG9QPF8J,Id: AIPAI4Z55IKG4PEYTP622
    customproperty9string
    Example: us-east-1
    descriptionstring
    Example:
    displaynamestring
    Example:
    endpointstring
    Example: AWS
    endpointKeynumber
    Example: 1
    entitlementIDstring
    Example: i-03d58cd60fa90b9a9

    entitlementMapDetails

    object[]

  • Array [

    • addDependentTaskstring
    Example:
    descriptionstring
    Example: Enable http, https, ssh access to the My ControlNode.
    excludeEntitlementstring
    Example:
    exportPrimarystring
    Example: sg-4341773f
    primarystring
    Example: sg-4341773f
    primaryEntKeystring
    Example: 189289
    primaryEntTypestring
    Example: AWSSecurityGroup
    removeDependentEntTaskstring
    Example:
    requestFilterstring
    Example:

  • ]

    • entitlementOwnerstring
    Example:
    entitlementTypestring
    Example: EC2InstanceDisplay
    entitlementTypeKeynumber
    Example: 52
    entitlementTypeNamestring
    Example: EC2Instance
    entitlement_glossarystring
    Example:
    entitlement_valuestring
    Example: i-03d58cd60fa90b9a9
    entitlement_valuekeystring
    Example: 191373
    requestFormstring
    Example: Request Form None
    soxcriticalstring
    Example: 0
    statusstring
    Example: 1
    syscriticalstring
    Example: 0
    updatedatestring
    Example: 2017-08-10 16:11:47

  • ]

    • entitlementsCountnumber
    Example: 1
    errorCodestring
    Example: 0
    msgstring
    Example: Successful
    totalEntitlementCountnumber
    Example: 1