Collect Accounts

Run one or more account collectors.

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

Request

Parameters

command	collectAccounts
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.
businessSource	The friendly name of the business source. If no business source is provided all business sources 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=collectAccounts&format=json&name=Collector1" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests, json

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

params = {
    "cmd": "collectAccounts",
    "format": "json",
    "force": "false"
}

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 ADC

{
    "data": {
        "type": "collectAccounts",
        "run-source-5514": "SAP SuccessFactors ADC",
        "run-id": "5514"
    }
}

200 All ADCs

{
    "data": {
        "type": "collectAccounts",
        "run-source-5593": "Oracle Databases - ADC1",
        "run-source-5591": "Okta ADC",
        "run-source-5629": "GitLab ADC",
        "run-source-5627": "MangoApps ADC",
        "run-source-5623": "Azure AD ADC",
        "run-source-5528": "SAP SuccessFactors ADC",
        "run-source-5526": "CyberArk (REST) - User Accounts & Groups ADC",
        "run-source-5558": "Authentication Manager ADC",
        "run-source-5589": "Microsoft Dynamics 365 ADC",
        "run-source-5587": "Genesys Cloud ADC",
        "run-source-5555": "Asana ADC",
        "run-source-5522": "GitHub Enterprise Cloud ADC",
        "run-source-5585": "IBM iSeries (AS400) ADC",
        "run-source-5520": "Aveksa ADC",
        "run-source-5552": "Amazon AWS IAM ADC",
        "run-source-5583": "Dropbox Business ADC",
        "run-source-5550": "Zoho CRM ADC",
        "run-source-5581": "Sentry ADC",
        "run-id": "5633,5635,5637,5520,5522,5526,5528,5530,5532,5534,5536,5538,5540,5542,5544,5546,5548,5550,5552,5555,5558,5562,5564,5566,5569,5571,5573,5575,5577,5579,5581,5583,5585,5587,5589,5591,5593,5595,5597,5599,5601,5603,5605,5607,5609,5611,5613,5615,5617,5619,5623,5627,5629,5631",
        "run-source-5619": "Active Directory ADC",
        "run-source-5617": "MangoApps ADC (Sandbox)",
        "run-source-5615": "WebFOCUS BI & Analytics ADC",
        "run-source-5613": "UNIX Servers ADC",
        "run-source-5611": "SQL Server Databases - ADC",
        "run-source-5548": "Freshservice ADC",
        "run-source-5579": "Deltek Costpoint ADC",
        "run-source-5546": "PagerDuty ADC",
        "run-source-5577": "DataReach Windows Account Collector",
        "run-source-5544": "Tableau ADC",
        "run-source-5575": "Sumo Logic ADC",
        "run-source-5542": "PingOne ADC",
        "run-source-5573": "Cherwell ADC",
        "run-source-5540": "Dynatrace ADC",
        "run-source-5571": "CA Workload Automation ADC",
        "run-source-5609": "ServiceNow ADC",
        "run-source-5607": "Salesforce ADC",
        "run-source-5605": "Oracle PeopleTools (PeopleSoft) ADC",
        "run-source-5637": "Jira Cloud ADC",
        "run-source-5603": "Miro ADC",
        "run-source-5635": "SecZetta ADC (Rester)",
        "run-source-5601": "Oracle Multi-App ADC",
        "run-source-5633": "UltiPro ADC (Rester)",
        "run-source-5631": "NetSuite ADC",
        "run-source-5538": "Qlik ADC",
        "run-source-5569": "Lucidchart ADC",
        "run-source-5536": "DocuSign ADC",
        "run-source-5599": "Litmos ADC",
        "run-source-5534": "Zendesk ADC",
        "run-source-5566": "Box Business ADC",
        "run-source-5597": "Oracle HCM Cloud ADC",
        "run-source-5532": "Zendesk 2 ADC",
        "run-source-5564": "AWS IAM  ADC",
        "run-source-5595": "Aha! ADC",
        "run-source-5530": "Azure DevOps ADC",
        "run-source-5562": "Datadog ADC"
    }
}

401 Missing Permissions

<html>
  <head>
    <title>Error</title>
  </head>
  <body>The token is not valid for the command 'collectAccounts'. </body>
</html>

401 Invalid Token

<html>
  <head>
    <title>Error</title>
  </head>
  <body>The token is not valid for the command 'collectAccounts'. Token is invalid or expired</body>
</html>

404 Invalid Parameter

<html>
  <head>
    <title>Error</title>
  </head>
  <body>Error running a collection for the application SAP SuccessFactor 
            Query String=cmd=collectAccounts&amp;format=json&amp;businessSource=SAP%20SuccessFactor&amp;force=false</body>
</html>