Find User Groups

Find user groups. The command uses the PV_USER_GROUP public view to find data.

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

Request

Parameters

command	findUserGroups
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 user identifier
name	Group name
idc_id	[Foreign Key referencing IDENTITY_COLLECTOR.ID] Identity collector id
guid	Identity of this group in Active Directory
creation_date	Date stamp when this group record was created
deletion_date	Date stamp when this group record was removed
application_id	Application id
add_state	Has the following values: 0 - no pending add 30 - pending CR creation 50 - pending approval 60 - pending delayed fulfillment 70 - pending fulfillment 80 - pending verification
remove_state	Has the following values: 0 - no pending remove 30 - pending CR creation 50 - pending approval 60 - pending delayed fulfillment 70 - pending fulfillment 80 - pending verification
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 (FSP) group memberships.
businessname	???
available_for_request	Same as CANREQUEST
backup_owner	Backup owner
long_description	Long description for this entry
long_desc	Long description for this entry
owner	Same as Owner_ID
owner_id	[Foreign Key referencing USERS.ID] Owner user id
short_description	Same as SHORT_DESC
short_desc	Short description for this entry
help_link	Same as URL_REF
url_ref	URL reference for this entry
alt_name	Alternate name for this entry
last_reviewed_date	Last reviewed date
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=findUserGroups&format=json" \
"&returnColumns=id%2Cname%2Cdescription%2Cowner%2Cexternal_id&returnMaxRows=5" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests

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

params = {
    "cmd": "findUserGroups",
    "format": "json",
    "returnColumns": "id,name,description,owner,external_id",
    "returnMaxRows": "5",
    "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: "findUserGroups",
    format: "json",
    returnColumns: "id,name,description,owner,external_id",
    returnMaxRows: "5",
    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

{
    "findUserGroups": [
        {
            "id": "10",
            "name": "Cloud-Users",
            "description": "",
            "owner": "",
            "external_id": "CN=Users,OU=ServiceGroups,OU=Users,OU=ops,DC=ops,DC=company,DC=com"
        },
        {
            "id": "35",
            "name": "Cbr-Gl",
            "description": "Access to G1 Servers",
            "owner": "",
            "external_id": "352"
        },
        {
            "id": "64",
            "name": "PSMMaster",
            "description": "",
            "owner": "",
            "external_id": "26"
        },
        {
            "id": "67",
            "name": "PVWAAppUsers",
            "description": "",
            "owner": "",
            "external_id": "17"
        },
        {
            "id": "86",
            "name": "Auditors",
            "description": "Auditors group",
            "owner": "",
            "external_id": "8"
        }
    ]
}