Audit Overview
The Audit tab allows both viewing and downloading records from the audit trail table for all portal operations. It is accessible when portalMode is enabled and the user has the Audit User role set in the Users tab.
You can define multiple filters to refine the records displayed. For example, you can specify a date range using "Since" (start date) and "Until" (end date) or apply filters based on specific column values. Multiple filters can be combined to narrow down the results effectively. Additionally, you have the option to download the filtered data to a text file. To ensure the filters apply to the downloaded data, check the box labeled "Include filters" in the dropdown menu next to the Download button. This way, only the records matching your selected criteria will be included in the download. If the "Include filters" checkbox is not selected, all records will be downloaded regardless of the applied filters.
Each record represents one of the possible states. Here are the explanations:
- APPROVED - Indicates that a role or session has been approved by an approver or was auto-approved if approvals needed is set to 0.
- CANCELED - Indicates that the session was canceled and ended by the user who initially requested it.
- CREATED - Indicates that the session was created.
- DENIED - Indicates that a role, and consequently the session, was denied by an approver.
- EXPIRED - Indicates that the session's time has run out and it has been terminated.
- GRANTED - Indicates that the session has started as its scheduled start time has arrived.
- TERMINATED - Indicates that the session was terminated by an admin.
Additionally, there is an option to view session details by hovering over its ID in the Session ID column. A small popup will display basic information about the session, including all roles and the justification provided by the requester.
Example:
In the screenshot above, we see example audit records for a session with ID 302. Reading from the bottom, we have the following information:
- Mark requested the session for roles role1 and role3. The session received the status CREATED, but it is not yet granted and is waiting for approvals.
- The user admin approves the role role3. A record with the APPROVED status and empty fields for session start time, end time, and session username indicates that the approval was for an individual role or roles rather than the entire session.
- Similarly, the user john approves the role role1.
- After receiving approvals for role1 and role3, the session changes its status to APPROVED. However, the text TBD in the session username column means that the session username has not yet been generated because the session has not started. If the session had already started, the session username field would display the name of the session user.
- The next record indicates that the session start time has arrived, and the session is marked as GRANTED, with the session user now created. From this point on, the created user has the requested roles and can log into the database.
- Finally, Mark decided he no longer needed the session, so he canceled it. The session changed its status to CANCELED, and the session user was removed from the database, meaning it can no longer be used.