Find Accounts

Find accounts. The command uses the PV_ACCOUNT public view to find data. Any filters passed should be passed on this public view.

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

Request

Parameters

command	findAccounts
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. csv - Comma separated values tsv - Tab separated values xml - Extensible Markup Language
delimiter	The delimiter to use between values for csv, properties formats
returnColumns	The names of the columns to return. returnColumns may be a CSV list of multiple column names. The returnColumns parameter may also be listed multiple times (ie returnColumns=col1,col2&returnColumns=col3,col4) Refer to Columns table below.
returnMaxRows	The maximum number of objects to return
distinct	true, false Returns only distinct values similar to the distinct keyword in SQL.
sortByColumns	The results will be sorted based on the columns listed using comma as the delimiter if multiple columns are specified. Refer to Columns table below.
sortDirection	This determines sorting order. When defined as 'asc' the sorting is in ascending order else in 'desc' descending order. If this parameter is not specified, the natural order of rows returned by database is used.
includeHeaderRow	true, false To include column headers when the return format is csv, tsv. (Default) true
ignoreCase	true, false Returns case insensitive search result for specified filter parameters. (Default) false

Columns

id	[Primary Key] Unique account identifier
name	Account name
creation_date	Date stamp when this account was created.
deletion_date	The date stamp when this account was removed.
expiration_date	The date on which the account expires.
application_id	[Foreign Key referencing APPLICATION.ID] Application/Directory id.
adc_id	[Foreign Key referencing ACCOUNT_COLLECTOR.ID] Account collector id.
adc_name	Account collector name
is_shared	Whether this account is shared by multiple users.
last_login_date	Last time when a user logged in using this account.
last_reviewed_date	Last reviewed date
is_locked	True, FalseIndicates if the current account is locked.
is_disabled	True, FalseIndicates if the current account is disabled.
is_shared	True, FalseWhether this account is shared by multiple users.
expiration_date	The date on which the account expires.
object_sid	Holds a unique string formatted value for an account created from Active Directory. This unique account value is used in resolving Active Directory 'Foreign Security Principles' group memberships.
orphaned_date	Date an account became orphaned.
orphaned_date	Date an account became orphaned.
cau1	Value of custom user type attributes configured on the instance represented by their reference names
cad1	Value of custom date type attributes configured on the instance represented by their reference names
cas1	Value of custom string type attributes configured on the instance represented by their reference names

Headers

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

Response

Parameters

The API returns the requested columns specified by returnColumns as output. If returnColumns is unspecified then all columns listed will be returned.

Examples

Request

Curl

curl -K -X GET  \
"https://instance.securid.com/aveksa/command.submit?cmd=findAccounts&format=json" \
"&returnColumns=id,name,application_id,last_login_date,cas9" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests

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

params = {
    "cmd": "findAccounts",
    "format": "json",
    "returnColumns": "id,name,application_id,last_login_date,cas9",
    "returnMaxRows": "10",
    "distinct": "true",
    "sortDirection": "asc"
}

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

Node.js

const axios = require('axios');

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

const params = {
    cmd: "findAccounts",
    format: "json",
    returnColumns: "id,name,application_id,last_login_date,cas9",
    returnMaxRows: "10",
    distinct: "true",
    sortDirection: "asc"
};

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

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

Response

200

{
    "findAccounts": [
        {
            "id": "267530",
            "name": "106003",
            "application_id": "1",
            "last_login_date": "",
            "cas9": "CN=106003,OU=dev,DC=company,DC=com"
        },
        {
            "id": "267525",
            "name": "107009",
            "application_id": "1",
            "last_login_date": "",
            "cas9": ""
        },
        {
            "id": "266229",
            "name": "5b6c7b3afbc68529c6c47967",
            "application_id": "244",
            "last_login_date": "",
            "cas9": ""
        },
        {
            "id": "266220",
            "name": "5cb4ae0e4b97ab11a18e00c7",
            "application_id": "244",
            "last_login_date": "",
            "cas9": ""
        }        
    ]
}