Use this endpoint to get a list of the filter values based on the filter selected. This endpoint is helpful when you wish to filter out the discovery audit logs based on filter criteria available.
curl --location --request POST 'https://daas.digicert.com/apicontroller/v1/auditlog/filter' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw
'{
"accountId": 5153184,
"searchCriteriaList": [{
"key": "userName",
"operation": "EQUALS",
"value": ["CertCentral Admin"]
}],
"divisionIds": [],
"isFromWallAlert": false,
"startIndex": 1,
"pageSize": 50,
"filterSelected": "divisionName",
"sortedColumnId": "createdDate",
"sortOrder": "ASC"
}'
{
"error": null,
"data": {
"filterName": "divisionName",
"displayName": "Division",
"values": ["Cert Testing Inc."]
}
}
Name | Req/Opt | Type | Description |
---|---|---|---|
accountId | required | string | Account ID. |
searchCriteriaList | optional | array |
Filter results by specified values. The array includes key, operation and value. For definitions, see the Filter options for searchCriteriaList table below.Example: searchCriteriaList:[{"key":"userName","operation":"EQUALS","value":["CertCentral Admin"]}]
|
divisionIds | required | array | User's division IDs. |
startIndex | optional | integer |
Index of the first result. Default: 1
|
pageSize | optional | integer |
Number of records per page. Allowed values: 0 to 512 Default: 50
|
filterSelected | required | string |
The value to show in the results for each sensor that meets the search criteria. Allowed values: userName , dateRange , function , ipAddress , divisionName
|
sortedColumnId | optional | string |
Sort results by specified parameter. Allowed values: createdDate , userName , ipAddress , divisionName , ipCountry Default: createdDate
|
sortOrder | optional | string |
Sort direction. Allowed values: DESC (descending: 9-0, Z-A), ASC (ascending: 0-9, A-Z)Default: DESC
|
Name | Type | Description |
---|---|---|
error | object | Includes error codes, if any. |
data | object | Object with information about the filter results. |
.. filterName | string |
Specified filter key .
|
.. displayName | string | Friendly name of the filter key as it appears in the UI. |
.. values | array |
List of items that meet the search criteria. The value shown is the value set for the filterSelected parameter in the request body.
|
The array includes key, operation and value.
Key | Operation | Value |
---|---|---|
userName
|
EQUALS |
Username
|
dateRange
|
EQUALS |
dateFrom -string , dateTo-string
|
function
|
EQUALS |
User action performed
|
ipAddress
|
EQUALS |
User IP address
|
divisionName
|
EQUALS |
Division name
|