Find Applications

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

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

Request

Parameters

command	findApplications
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 application identifier
name	Application name
created_by	[Foreign Key referencing USERS.ID] User id that created this application
creation_date	Date stamp when this application was created
description	Description associated with this application
sensitivity	Sensitivity
ownership	Ownership
locality	Locality
business_owner	[Foreign Key referencing USERS.ID] Business owner user id
technical_owner	[Foreign Key referencing USERS.ID] Technical owner user id
exception_manager	[Foreign Key referencing USERS.ID] Exception manager user
business_unit_id	[Foreign Key referencing BUSINESS_UNIT.ID] Related business unit id
alt_name	Alternate name for this entry
short_desc	Short description for this entry
long_desc	Long description for this entry
url_ref	URL reference for this entry
user_count	Total number of collected users for this application
account_count	Total number of collected accounts for this application
orphaned_account_count	Total number of collected accounts for this application that do not map to any user
entitlement_count	Total number of collected entitlements for this application
category	Category
exclude_from_normal_add_access	Exclude application from normal add access
allow_create_entitlement	Allow create entitlement
allow_manual_activity	Allow manual activity
ents_require_account	Stores true and false and signifies whether entitlements added to the users have to come from an account
directory_for_accounts	Stores the directory of the accounts for the application
rules_account_template_id	Signifies the account template to be used when a change request is created from Rules to add entitlements to this application
attr_sync_enabled	Stores true and false and signifies whether attribute sync feature is enabled
allow_disabled_accounts	Stores true and false and signifies whether the disabled accounts are allowed to be collected
allow_locked_accounts	Stores true and false and signifies whether the locked accounts are allowed to be collected
roles_account_template_id	Signifies the account template to be used when a change request is created from Roles to add entitlements to this application
business_owner_name	Business owner display name
technical_owner_name	Technical owner display name
exception_manager_name	Exception manager display name
editable	TRUE, FALSEIf the application is editable.
backup_business_owner	[Foreign Key referencing USERS.ID] Backup business owner
backup_technical_owner	[Foreign Key referencing USERS.ID] Backup technical owner
business_criticality	Specifies the level of criticality for the business source
privileged_flag	Specifies that the business source manages and controls privileged access
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=findApplications&format=json" \
"&returnColumns=id%2Cname%2Cdescription&category=DEV" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests

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

params = {
    "cmd": "findApplications",
    "format": "json",
    "returnColumns": "id,name,description",
    "returnMaxRows": "50",
    "distinct": "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}")

Node.js

const axios = require('axios');

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

const params = {
    cmd: "findApplications",
    format: "json",
    returnColumns: "id,name,description",
    returnMaxRows: "50",
    distinct: "true"
};

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

{
 "findApplications": [{
   "id": "70",
   "name": "Cherwell",
   "description": "Cherwell Service Management is a cloud-based IT service management solution that helps IT teams in organizations to implement, automate and upgrade service and support processes."
  },
  {
   "id": "71",
   "name": "DataReach AWS",
   "description": "This application will contain the AWS accounts and permission and will be used for recertification purpose."
  },
  {
   "id": "72",
   "name": "Deltek Costpoint",
   "description": "Deltek CostPoint is an ERP software solution designed for government contractors. It enables users to manage project accounting, labor management, manufacturing, and business intelligence. Modules include payroll, budgeting and planning, reporting, human resources and benefits, manufacturing and compliance, subcontractor management, time and expense, contract management, and enterprise insights for planning and forecasting."
  },
  {
   "id": "73",
   "name": "Dropbox Business",
   "description": "Share, sync, and collaborate on files securely with Dropbox Business, a file sharing and cloud storage solution that employees love and IT admins trust."
  },
  {
   "id": "74",
   "name": "Generic SecurID Tokens",
   "description": "Represents generic requestable tokens meant to allow the system to request the “next available” token"
  }
 ]
}