Audit logging allows you to record both user driven and automated activity relating to your Insight solutions. For every auditable action, you can see what the action was, the time that the action occurred, and who completed the action. By enabling audit logging, you have the ability track activity for investigative purposes. Audit logging will also help you fulfill compliance requirements if these details are requested by an external auditor.
You must have Administrator permissions to enable audit logging and to view audit log events.
Audit logging is in Open Preview and currently supports audit events from several Insight products
During Open Preview, you will have the opportunity to test audit logging in Insight Platform, InsightIDR, InsightAppSec, and InsightVM's Custom Policy Builder and provide feedback to Rapid7. This feedback will be incorporated as Rapid7 makes improvements to the feature and builds audit logging functionality for all Insight products.
To use the audit logging feature in the Insight Platform:
Enable audit logging
To enable audit logging:
- From the Platform home, click Settings > Company Settings > Audit Log.
- Set the toggle to Enabled.
- Select the region where you want to store your audit log data.
You enabled audit logging!
Once you turn on audit logging, the Insight Platform will immediately begin collecting all Platform and InsightIDR events.
View your audit log events
You can view your audit Log events in the Insight Platform by going to the top navigation menu and clicking Settings > Audit Log.
To view your events, you can use the Audit Source log selector drop down to filter the table to show specific audit logs. You can also choose to view All Audit Logs. For each event on the table, you can see the time that the action occurred, details (Name and Email) of who completed the action and the product that the action occurred within.
You can filter to view actions taken by a specific user by searching for their username in the search bar. You also have the ability to search for any string within this search bar, such as an email or action.
You can also confine your search to specific date ranges using the date selector component as part of the search bar. You can either type in the date range manually using the date/time box provided or you can click on the calendar to select the date range.
You can export your log search results to a CSV file directly from the Audit Table using the Export to CSV function beside the search bar. Once the CSV file has been exported, a green bar will appear and you will have the option to download it.
To view more details about an audit log Event, click View More in the More Details column. A window with additional details about the specific audit log event will appear.
More Details Modal limitations during Open Preview
Description fields are not available in the More Details modal during Open Preview, but will be provided when audit logging moves to General Availability. The More Details modal currently provides contextual information to help you better understand the result of the audit event action.
InsightIDR audit log events
To see the InsightIDR audit log messages, read the audit logging documentation on the InsightIDR documentation site.
InsightAppSec audit log events
For information about InsightAppSec audit log messages, see audit logging in the InsightAppSec documentation site.
Custom Policy Builder
Within InsightVM's Custom Policy Builder, you can use audit logging to capture every policy update implemented by users. Audit logs record who, when, and what changes were made to a policy so a user or an auditor can view the change history of any policy at a later date. For more information, see the audit logs topic of the Custom Policy Builder InsightVM documentation.
Platform audit log events
This section outlines audit log events currently generated by Insight Platform Services. The events are sorted into the following categories:
- API Key
- External Identity Provider (IDP)
- Key Contacts
- Multi-Factor Authentication (MFA)
- Password Policy
- Organization Product
- User Role
- User Access
- Role Based Access Control (RBAC)
- Audit Log
API key events
|API_KEY_CREATED||New API key was created|
|API_KEY_DELETED||API key was deleted|
|API_KEY_MOVED||API key was moved to a new customer account due to a customer account merge|
External identity provider (IDP) events
|EIDP_ENABLED||User Authentication using an External IDP was enabled|
|EIDP_DISABLED||User Authentication using an External IDP was disabled|
|EIDP_X509_CERT_UPLOADED||An X509 security certificate was uploaded for the External IDP|
|EIDP_UPDATED||The configuration profile for the External IDP used for user authentication was updated|
|EIDP_DELETED||The configuration profile for the External IDP used for user authentication was deleted|
|JIT_PROFILE_UPDATED||The Just In Time provisioning profile applied to users accessing the Insight Platform from an External IDP was updated|
Key contact events
|KEY_CONTACT_ADDED||New Key Contact was added|
|KEY_CONTACT_REMOVED||Key Contact was removed|
Multi-factor authentication (MFA) events
|MFA_UPDATED||MFA configuration data was changed|
|ORG_NAME_UPDATED||Organization Display Name was changed|
|ORGANIZATION_MOVED||The organization was moved from one customer account to another due to a customer account merge|
Password policy events
|PASSWORD_POLICY_UPDATED||Password policy was modified|
Organization product events
|ORG_PRODUCT_CREATED||A new Insight Product License was added to the Customer’s organization|
|PRODUCT_TRIAL_EVENT||A new product free trial was started|
|USER_ACCOUNT_RESET||User account was reset|
|USER_CREATED||New user was created|
|USER_DELETED||User account was deleted|
|USER_MFA_RESET||User MFA was reset|
|USER_SUCCESS_LOGIN||User logged in|
|USER_UPDATED||User profile was updated|
|USER_ACTIVATED||User account was activated|
|USER_CHANGED_PASSWORD||User changed their password|
|USER_CHANGED_SECURITY_QUESTION||User changed their security question|
|USER_ACTIVATION_RESENT||User account activation email resent|
|USER_FORGOTTEN_PASSWORD||User forgot their password|
|USER_MOVED||User account was moved to another customer account due to a customer account merge|
|USER_LOGOUT||User logged out|
User role events
|USER_ROLE_SET||User role was set or updated|
User access events
|USER_TO_ORG_PRODUCT_CREATED||A user was assigned access to a product|
|USER_TO_ORG_PRODUCT_DELETED||A user was unassigned access to a product|
|USER_TO_PRODUCT_NAVIGATION||A user navigated to access a specified product|
|USER_SWITCHED_CUSTOMER||A user with multi customer account access navigated from their primary customer account to access another customer account|
|USER_CUSTOMER_MOVED||A user account was moved from one customer account to another due to a customer account merge|
|CUSTOMER_NAME_UPDATED||The Customer Account Name was updated|
|CUSTOMER_MERGED||The Customer account was merged with another customer account|
Audit log events
|AUDIT_LOG_OPT_IN||Audit Logging was turned on|
|AUDIT_LOG_OPT_OUT||Audit Logging was turned off|
Query your audit logs
You can also query your audit logs by adding the log ID to the specified URL or filter audit logs by adding Log Entry Query Language to the URL.
Retrieve Insight Platform audit logs using the API
If you have an organization-level API key or a Platform Admin user key, you can query logs using the REST API. With this functionality, you query a single audit log or multiple audit logs.