ZTrust Documentation
  • User Manual - ZTrust V3.0
    • Key Terminologies
    • Guide to Navigation
      • Clients
        • Clients List
        • Initial Access Token
        • Client Registration
      • Client Scopes
      • Realm Roles
      • Users
      • Groups
      • Sessions
      • Events
        • User events
        • Admin events
      • Realm Settings
        • General
        • Login
        • Email
        • Themes
        • Keys
        • Events
        • Localization
        • Security Defenses
        • Sessions
        • Tokens
        • Client Policies
        • User profile
        • User Registration
      • Authentication
        • Flows
        • Required Actions
        • Policies
      • Identity Providers
      • User Federation
    • Admin Manual
      • Creation of a Realm
      • Creation of a User
        • Login to Account Console
      • How to set up Password Invalidator
      • How to set up Password Policies
      • How to set up Brute Force Detection feature
      • How to enable the One-to-Many feature
      • How to set up Multi-Factor Authentication
        • Setup of ReCAPTCHA registration flow
        • Setup of ReCAPTCHA login flow
        • Setup of OTP Based Registration
        • Setup of OTP Based Login
        • Setup of QR Code Based Authentication
        • Setup of Push Notification Based Authentication
        • Setup of Biometric based Authentication
        • How to set-up 2FA Authentication
      • ZTrust Authenticator App
      • Self-Service Portal (SSP)
        • Authenticator Setup from Self-Service Portal
        • Set Your Profile Photo in Self-Servicce Portal
      • How to setup Session Invalidator feature
      • How to setup GDPR Compliant feature
      • How to set up Social Media login
      • How to setup Inactive User Tracking feature
      • How to setup Archive Inactive User feature
      • Role-Specific Attribute Based Access Control at client level
      • Self-Role Request at the Business Level
      • Self-Role Request at the Application Level
      • How to setup Delete Archived/Inactive User feature
      • Reporting Module
      • Geo Tagging and Fencing
      • Event Type
  • Release Notes
    • ZTrust V3.1.0
    • ZTrust V3.0.0
    • ZTrust V2.1.0
    • ZTrust V2.0.1
    • ZTrust V2.0.0
    • ZTrust V1.0.4
    • ZTrust V1.0.3
    • ZTrust V1.0.2
    • ZTrust V1.0.1
    • ZTrust V1.0.0
  • Frequently Asked Questions
  • User Manual - ZTrust V2.0
    • Key Terminologies
    • Guide to Navigation
      • Clients
        • Clients List
        • Initial Access Token
        • Client Registration
      • Client Scopes
      • Realm Roles
      • Users
      • Groups
      • Sessions
      • Events
        • User events
        • Admin events
      • Realm Settings
        • General
        • Login
        • Email
        • Themes
        • Keys
        • Events
        • Localization
        • Security Defenses
        • Sessions
        • Tokens
        • Client Policies
        • User profile
        • User Registration
      • Authentication
        • Flows
        • Required Actions
        • Policies
      • Identity Providers
      • User Federation
    • Admin Manual
      • Creation of a Realm
      • Creation of a User
        • Login to Account Console
      • How to set up Password Invalidator
      • How to set up Password Policies
      • How to set up Brute Force Detection feature
      • How to enable the One-to-Many feature
      • How to set up Multi-Factor Authentication
        • Setup of ReCAPTCHA registration flow
        • Setup of ReCAPTCHA login flow
        • Setup of OTP Based Registration
        • Setup of OTP Based Login
        • Setup Time-based One-Time Password (TOTP) Based Login
        • Setup of QR Code Based Authentication
        • Setup of Push Notification Based Authentication
        • Setup of Biometric based Authentication
        • How to set-up 2FA Authentication
      • How to setup Session Invalidator feature
      • How to setup GDPR Compliant feature
      • How to set up Social Media login
      • How to setup Inactive User Tracking feature
      • How to setup Archive Inactive User feature
      • How to setup Delete Archived/Inactive User feature
      • Role-Specific Attribute Based Access Control at client level
      • Reporting Module
      • Geo Tagging and Fencing
      • Event Type
  • User Manual - ZTrust V1.0
    • Guide to Navigation
      • Realm Settings
        • General
        • Login
        • Keys
        • Email
        • Themes
        • RabbitMQ Config
        • Localization
        • Cache
        • Tokens
        • Client Registration
        • Client Policies
        • Security Defenses
      • Clients
      • Client Scopes
        • Default Client Scopes
      • Roles
        • Realm Roles
        • Default Roles
      • Identity Providers
      • User Federation
      • Authentication
        • Flows
        • Bindings
        • Required Actions
        • Password Policy
        • OTP Policy
        • WebAuthn Policy
        • WebAuthn Passwordless Policy
        • CIBA Policy
      • Groups
        • Default Groups
      • Users
      • Sessions
        • Realm Sessions
        • Revocation
      • Events
        • Login Events
        • Admin Events
        • Config
      • Import
      • Export
    • Admin Manual
      • Creation of a Realm
      • Creation of a User
        • Login to Account Console
      • How to set up Password Invalidator
      • How to set up Password Policies
      • How to set up Brute Force Detection feature
      • How to enable the One-to-Many feature
      • How to set up Multi-Factor Authentication
        • Setup of ReCAPTCHA registration flow
        • Setup of ReCAPTCHA login flow
        • Setup of OTP Based Registration
        • Setup of OTP Based Login
        • Setup of QR Code Based Authentication
        • Setup of Push Notification Based Authentication
        • Setup of Biometric based Authentication
      • How to setup Session Invalidator feature
      • How to setup GDPR Compliant feature
      • How to set up Social Media login
      • How to setup Inactive User Tracking feature
      • How to setup Archive Inactive User feature
      • How to setup Delete Archived/Inactive User feature
Powered by GitBook
On this page
  1. User Manual - ZTrust V3.0
  2. Guide to Navigation
  3. Realm Settings

Events

PreviousKeysNextLocalization

Last updated 10 months ago

Within the Events section, various events can be saved.

Event Listeners

Event Listeners monitor events and execute actions accordingly.

ZTrust includes two built-in event listeners: the Logging Event Listener and the Email Event Listener.

When the Logging Event Listener is enabled, the listener logs error events to a designated log file.

You can utilize this listener to safeguard against hacker bot attacks.

The Email Event Listener sends an email notification to the user's account upon occurrence of an event. It supports the following events -

  • Login Error

  • Update Password

  • Update Time-based One-time Password (TOTP)

  • Remove Time-based One-time Password (TOTP)

You can choose the most suitable option from the dropdown based on your requirements.

Click on the 'x' symbol to remove it.

User events settings

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.

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 user events

This will delete all the events in the database.

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.

You can use the search box to search for a specific event.

Click the Refresh button to see the latest settings.

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 type

It determines which event types are saved.

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.