Find Users

Find users. The command uses the PV_USERS public view to find data.

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

Request

Parameters

command	findUsers
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
idc_id	[Foreign Key referencing IDENTITY_COLLECTOR.ID] Identity collector 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
backup_supervisor_name	Backup supervisor name
supervisor_id_name	Supervisor's name
supervisor_id	[Foreign Key referencing USERS.ID] Supervisor user id
availability_status	Used for Out of Office functionality
backup_supervisor	Backup supervisor
business_unit_id	[Foreign Key referencing BUSINESS_UNIT.ID] Business unit id
creation_date	Date stamp when this user record was created
deletion_date	Date stamp when this user record was removed
user_id	User's external identifier
unique_id	User's external unique identifier
first_name	User's first name
last_name	User's last name
title	User's title in the organization
department	User's department name
email_address	User email address
job_status	User job status
is_terminated	true, falseIndicates the termination state for the user.
termination_date	Termination date
jml_status	Joiner, mover, and leaver status used internally.
exception_count	Exception count
violation_count	Violation count
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=findUsers&format=json" \
"&returnColumns=id%2Cuser_id%2Cfirst_name%2Clast_name%2Cemail_address%2Cis_terminated" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests

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

params = {
    "cmd": "findUsers",
    "format": "json",
    "returnColumns": "id,user_id,first_name,last_name,email_address,is_terminated",
    "returnMaxRows": "50",
    "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

Response

200

{
    "findUsers": [
        {
            "id": "247852",
            "user_id": "103307",
            "first_name": "Kara",
            "last_name": "Leary",
            "email_address": "14jun@today.com",
            "is_terminated": "False"
        },
        {
            "id": "247853",
            "user_id": "16026562681",
            "first_name": "Runscope1",
            "last_name": "Alan1",
            "email_address": "New1602656268B@aquera.com",
            "is_terminated": "False"
        },
        {
            "id": "247854",
            "user_id": "hind1",
            "first_name": "",
            "last_name": "",
            "email_address": "",
            "is_terminated": "False"
        }
    ]
}