Audit Fields
This topic describes the fields recorded in audit log events.
| Audit Fields | Descriptions |
|---|---|
event_time
|
Time when the audit log was recorded, in UNIX timestamp milliseconds (in UTC). |
app
|
Indicates the application within the platform. Possible values include See Audit Logs for Security Analytics for more information on events that are audited within these applications. |
|
api Captures information about API calls that a user makes, including but not limited to:
Audit your API call Here's a typical search query to audit your API calls:
How do I check if my API call failed? The following query should help you check what about your API call failed:
This query helps you check which API calls failed and returned the 400 status code. For example,you can use the
In the example |
|
|
alert Captures all the details about alerts, including the alert status, any events that were throttled, and the response after the alert is triggered. How do I check if a scheduled alert failed? Since alerts send JSON response payloads, use the json_extract function in the calc operator to filter the results as per the alert status, as follows: Step 1: Audit alerts using the following query: Copy
Step 2: Filter the results based on the status of these alert results from Step 1. Copy
This query will return all the failed alerts, including the response_digest and request_payload that specifically point out what went wrong in the alert. Step 3: Check the alert request payload. For example, this is a cron-based alert: Copy
Step 4: Check the response digest. It indicates the provided request URI was invalid (400 Bad Request): Copy
How do I check which are the common types of alert failure? The following query counts the frequency of all the types of alert failures: Copy
|
|
|
search Captures details about various searches, including:
|
|
|
ts_user_action Captures ThreatStream user actions. See Audit Lookup Table (ThreatStream) for the list of available ThreatStream user actions. |
|
|
identity_sync Captures identity provider synchronization events, such as user and group provisioning updates between the platform and an external identity provider. |
|
category
|
The category of user action that was logged, including |
user
|
The platform user who initiated the action. This value is the email address of the user. |
action
|
Type of the activity recorded, including |
client_ip
|
IP address of the client that initiates the activity. |
timestamp
|
The date and time (local time) the activity was recorded. For example, |
elapsed_ms
|
Total time taken (in milliseconds) to execute the search or API request. |
user_agent
|
The user agent of the client that performed the request. |
http_method
|
The method used in an HTTP request, such as |
status_code
|
The HTTP status code returned in response to the request. |
search_query
|
The query submitted by the user. For example: Copy
|
saved_search_name
|
The name of the saved search. This lets you determine which searches are run through search queries in the AQL Search Box and searches that arise from saved searches. |
search_start_time
|
Start of the |
search_end_time
|
End of the |
search_job_id
|
The unique ID of a submitted Search job. This is typically a 32-character alphanumeric ID. |
request_uri
|
URI of the requested HTTP resource. |
request_payload
|
The HTTP request body, in JSON format. You can use it to obtain information about your search. For example, in the following payload: Copy
the 'origin' key tells you that the search originated from a event search. Other possible sources of origins are from a dashboard or an alert. See the AQL calc operator to understand how you can use json_extract to filter your audit results based on the fields in the request body. |
response_digest
|
The summary of the response content, typically in JSON format. See the AQL calc operator to understand how you can use the json_extract function to filter your audit results. For example, you can filter down a failed alert using the json_extract function based on the fields in the response, as follows: Copy
This query returns all the failed alerts, an error message that indicates the error in the alert, the total number of events and throttled events. |
request_bytes
|
The total size of the request body and headers (in bytes). |
response_bytes
|
The total size of the request body and headers (in bytes). |
Audit Logs for Security Analytics
The following tables list all the audited events for Security Analytics applications:
api
| User Actions in Security Analytics | Descriptions |
|---|---|
submit_job
|
User submitted a job for the feature specified in the |
create
|
User created the object specified in the |
update
|
User updated the object specified in the |
delete
|
User appended data to the lookup specified in the |
alert
| User Actions in Security Analytics | Descriptions |
|---|---|
run_alert
|
A scheduled alert ran for the item specified in the |
alert_triage
|
User set a status or disposition on the alert specified in the |
alert_email
|
An alert email notification was sent for the alert specified in the |
search
| User Actions in Security Analytics | Descriptions |
|---|---|
run_job
|
A job ran for the feature specified in the |
create_lookup
|
User created the lookup specified in the |
append_lookup
|
User appended data to the lookup specified in the |
ts_user_actions
| User Actions in ThreatStream | Descriptions |
|---|---|
accepted-chat-eula
|
The user accepted the Chat End of User License Agreement. |
added-description
|
The user added or modified the Summary text on the user's Profile page. |
|
|
The user granted a user permission on the ThreatStream Settings > User Admin page. |
advanced-search
|
The user initiated advanced-search. |
asset-issue-status-change
|
The user assigned a status to the asset issue. |
commented
|
The user added a comment to the object specified in the category field. |
|
|
The user created the object specified in the category field. |
deleted
|
The user deleted the object specified in the category field. |
downvoted
|
The user disliked the intelligence. |
exported
|
The user exported the object specified in the category field. |
|
|
The user logged out by clicking the Logout link. |
marked-complete
|
The user marked an intelligence initiative specified in the category field as complete. |
mitre_score
|
The user updated the MITRE ATT&CK Security Control Framework for your organization. |
mitre_version
|
The user updated the MITRE ATT&CK version. |
|
|
The user removed a user permission on the ThreatStream Settings > User Admin page. |
search
|
The user initiated basic search. |
|
|
The user signed in by specifying their user name and password. |
signed-in-sso
|
The user logged in using SSO. |
starred
|
The user bookmarked the intelligence. |
|
|
The user updated the object specified in the category field. |
uploaded-avatar
|
The user uploaded an avatar to the user's own Profile page. |
upvoted
|
The user liked the intelligence. |
viewed
|
The user viewed the intelligence. |
watched
|
The user requested to receive notifications when the intelligence is updated. |
identity_sync
| User Actions in Security Analytics | Descriptions |
|---|---|
identity_create
|
An identity was created or discovered during an identity sync. The |
connector_sync_complete
|
An identity connector (for example, a GCP IAM connector) completed a sync for the connector specified in the |