Collect Identities
Run one or more identity collectors.
GET https://instance.securid.com/aveksa/command.submit?cmd=collectIdentities
Request
Parameters
| collectIdentities | |
| 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. |
| unify | true, false Indicates if a subsequent unification should run. |
| force | true, false Indicates if a collection should be "forced", i.e. ignore circuit breaker thresholds. |
Headers
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
- Python
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=collectIdentities&format=json&unify=true" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests, json
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "collectIdentities",
"format": "json",
"name": "HR Users",
"unify": "true",
"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 IDC
- 200 All IDCs
- 404 Invalid Parameter
- 409
{
"data": {
"type": "collectIdentities",
"run-id": "5733,5734",
"run-source-5733": "HR Users"
}
}
{
"data": {
"type": "collectIdentities",
"run-source-5743": "SAP SuccessFactors IDC",
"run-id": "5744,5745,5746,5747,5748,5749,5742",
"run-source-5748": "HR Database (Internal)",
"run-source-5747": "SecZetta IDC (Rester)",
"run-source-5746": "UltiPro IDC - Rester",
"run-source-5745": "SAP Fieldglass IDC",
"run-source-5744": "HR Users"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>Error running a collection for the identity collector D
Query String=cmd=collectIdentities&format=json&name=D&unify=true&force=false</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>Cannot schedule Identity Collections and/or Unification because they are already in the queue for
processing Query String=cmd=collectIdentities&format=json&unify=true&force=false</body>
</html>