Collect Data Access

Run one or more data access collectors.

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

note

Requires a user with System:Manage privilege.

Request

Parameters

command	collectDataAccess
format	properties - (Default) Returns the response as key=value pairs. When multiple collectors run, run-id is a CSV of all run IDs. json - Returns the response as JSON.
name	The friendly name of the collector to run. If omitted, all data access collectors are processed.
force	Set to true to ignore circuit breaker thresholds and force collection regardless of prior run state.

Headers

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

Response

Parameters

run-id	The ID assigned to the collection run. When multiple collectors run, this is a CSV of all run IDs.
run-source-xx	The name of the collector for run ID xx. One key appears per collector that ran.

Examples

Request

Curl

curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=collectDataAccess&format=json&name=Sample+DAG" \
-H "Authorization: Bearer <token>"

Python

import requests

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

params = {
    "cmd": "collectDataAccess",
    "format": "json",
    "name": "Sample DAG"
}

headers = {
    'Authorization': 'Bearer <token>'
}

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}")

Node.js

const axios = require('axios');

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

const params = {
    cmd: "collectDataAccess",
    format: "json",
    name: "Sample DAG"
};

const headers = {
    'Authorization': 'Bearer <token>'
};

axios.get(url, { params, headers })
    .then(response => {
        if (response.status === 200) {
            console.log(response.data);
        } else {
            console.log(`Request failed with status code ${response.status}`);
        }
    })
    .catch(error => {
        console.error('Error:', error);
    });

Response

200 (Properties)

Default format when format is omitted.

run-id=1001
run-source-1001=Sample DAG

200 (JSON)

{
    "data": {
        "type": "collectDataAccess",
        "run-id": "1001",
        "run-source-1001": "Sample DAG"
    }
}

401 Invalid Token

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

401 No Token

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The token is required for the command 'collectDataAccess'</body>
</html>

404 Invalid name

Returned when the name value does not match any data access collector, or when no data access collectors are configured.

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Error running a collection for the data access collector InvalidName
 Query String=cmd=collectDataAccess&amp;format=json&amp;name=InvalidName</body>
</html>

404 No collectors

Returned when name is omitted but no data access collectors are configured on the server.

<html>
    <head>
        <title>Error</title>
    </head>
    <body>Error running a collection for the data access collectors
 Query String=cmd=collectDataAccess&amp;format=json</body>
</html>

See Also

• Get Run Status
• Collect Accounts
• Collect Entitlements