Events
The Events section in ZTrust allows administrators to track, save, and manage system events related to user activity, authentication, and system notifications. Events help in monitoring authentication activities, auditing changes, and enhancing system security.
Event Listeners
Event Listeners monitor events and execute specific actions based on those events. ZTrust includes two built-in event listeners:
Logging Event Listener
When enabled, this listener logs events (including error events) to a designated log file.
It is especially useful for detecting and preventing hacker bot attacks.
Email Event Listener
Sends email notifications to users whenever a specific event occurs.
Supported events include:
Login Error
Update Password
Update Time-based One-Time Password (TOTP)
Remove Time-based One-Time Password (TOTP)
You can enable or disable event listeners as required using the dropdown menu. Click on the ‘x’ symbol to remove an enabled listener.
User Events Settings
This section allows you to configure how ZTrust records and manages user-related events.
Save Events
Toggle ON → Login and user events are saved in the database and can be viewed via the Admin Console or Account Management Console.
Toggle OFF → Events will not be stored.
Expiration
Defines how long user events are retained in the database before they are automatically deleted.
Configure the retention period based on your organization's auditing and compliance requirements.
This field establishes the expiration duration for events, dictating how long they are retained in the database.
Expired events are regularly removed from the database based on this setting.
You can tailor this setting according to your needs.
Clear User Events
Clicking this option will delete all saved user events from the database.
Use cautiously, as deleted data cannot be recovered.
Save
To save and implement changes, click Save after making adjustments.
Cancel
If you prefer not to apply any changes, click on the Cancel button to discard the changes.
Search and Refresh
Use the search box to locate a specific event.
Click Refresh to view the latest event data.
You can also choose how many event types you want to display on one screen. Select your preferred option from the dropdown menu as shown above.
Event Saved Types
This section allows you to define which types of events should be saved.
Steps to Add Saved Event Types
Click Add Saved Types.
A prompt appears showing the list of available event types.
Use the search box to find a specific event type.
Select the checkbox next to the event type(s) you want to save.
Click Add to include them under Saved Events.
Description
After clicking on Add saved types, you will be prompted to select the event type that you want to add to Saved events.
You can use the search box to search for a specific event.
Click the Refresh button to see the latest settings.
To choose a specific event type, click on the checkbox next to it. Then, click on Add to include the event under Saved events.
You can also choose how many event types you want to display on one screen. Select your preferred option from the dropdown menu as shown above.
Save Events
This is a toggle button, when activated (turned ON), login events are saved to a database, allowing access through the admin and account management consoles.
When deactivated (turned OFF), the events are not retained.
Include representation
This toggle button controls the inclusion of JSON representation in create and update requests. When toggled ON, JSON representation is included; when toggled OFF, it is not.
You can switch it ON or OFF according to your needs.
Expiration
This field establishes the expiration duration for events, dictating how long they are retained in the database.
Expired events are regularly removed from the database based on this setting.
You can tailor this setting according to your needs.
Clear admin events
This will delete all the events in the database.
Save
To save and implement changes, click Save after making adjustments.
Revert
If you prefer not to finalize your alterations, click on Revert.
This action will discard all changes made.
Last updated