Collect Entitlements

Run one or more account collectors.

GET https://instance.securid.com/aveksa/command.submit?cmd=collectEntitlements

Request

Parameters

command	collectEntitlements
format	properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc. json - Useful format for parsing into javascript or other languages. See www.json.org for details.
name	The friendly name of the collector. If no name is provided all collectors are processed.
application	The friendly name of the application. If no name is provided all applications are processed.
force	true, false Indicates if a collection should be "forced", i.e. ignore circuit breaker thresholds.

Headers

Authorization	Bearer token
Accept	application/json
Content-Type	application/json

Response

Parameters

type	Executed command name
run-id	The id assigned to the collection.
run-source-xx	The names of the collectors that we processed as part of this run where xx is the run id.

Examples

Request

Curl

curl -K -X GET  \
"https://instance.securid.com/aveksa/command.submit?cmd=collectEntitlements&format=json&application=app1" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests, json

url = "https://instance.securid.com/aveksa/command.submit"

params = {
    "cmd": "collectEntitlements",
    "format": "json",
    "application": "SAP SuccessFactors",
    "force": "true"
}

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Request failed with status code {response.status_code}")

Response

200 Single Application

{
    "data": {
        "type": "collectEntitlements",
        "run-id": "5649",
        "run-source-5649": "SAP SuccessFactors EDC"
    }
}

200 All Applications

{
    "data": {
        "type": "collectEntitlements",
        "run-source-5727": "Azure AD EDC",
        "run-source-5725": "WebFOCUS BI & Analytics EDC",
        "run-source-5723": "SQL Server Databases - EDC1",
        "run-source-5721": "ServiceNow EDC",
        "run-source-5659": "Zendesk EDC",
        "run-source-5689": "Genesys Cloud EDC",
        "run-source-5657": "Azure DevOps EDC",
        "run-source-5687": "Sentry EDC - Roles",
        "run-source-5655": "SAP SuccessFactors EDC",
        "run-source-5685": "Sentry EDC - Projects",
        "run-source-5653": "CyberArk (REST) - Safes - EDC",
        "run-source-5683": "Sumo Logic EDC",
        "run-source-5651": "Aveksa EDC",
        "run-source-5681": "Lucidchart EDC",
        "run-source-5717": "Oracle PeopleTools (PeopleSoft) EDC",
        "run-source-5715": "Oracle HCM Cloud EDC",
        "run-source-5711": "Oracle Databases - EDC",
        "run-id": "5697,5699,5701,5703,5705,5707,5709,5711,5651,5715,5653,5717,5655,5657,5721,5659,5723,5661,5725,5663,5727,5665,5729,5667,5731,5671,5673,5675,5677,5679,5681,5683,5685,5687,5689,5691,5693,5695",
        "run-source-5679": "Datadog EDC",
        "run-source-5677": "Asana EDC",
        "run-source-5675": "Zoho CRM EDC",
        "run-source-5673": "PagerDuty EDC",
        "run-source-5671": "Tableau EDC",
        "run-source-5709": "Okta EDC",
        "run-source-5707": "Microsoft Dynamics 365 EDC",
        "run-source-5705": "IBM iSeries (AS400) eDC",
        "run-source-5703": "AWS IAM EDC",
        "run-source-5701": "Cherwell EDC",
        "run-source-5731": "SecZetta EDC (Rester)",
        "run-source-5667": "PingOne EDC",
        "run-source-5699": "CA Workload Automation EDC",
        "run-source-5665": "Qlik EDC",
        "run-source-5697": "Authentication Manager EDC",
        "run-source-5695": "Amazon AWS IAM EDC",
        "run-source-5663": "DocuSign EDC",
        "run-source-5693": "Freshservice EDC",
        "run-source-5661": "Zendesk 2 EDC",
        "run-source-5691": "Aha! EDC",
        "run-source-5729": "Jira Cloud EDC"
    }
}

404 Invalid Parameter

<html>
  <head>
    <title>Error</title>
  </head>
  <body>No eligible collectors found for the application SAP SuccessFactor 
    Query String=cmd=collectEntitlements&amp;format=json&amp;name&amp;application=SAP%20SuccessFactor&amp;force=true</body>
</html>