Update docs about when emails for changed credentials are sent

Closes #27620

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Signed-off-by: andymunro <48995441+andymunro@users.noreply.github.com>
This commit is contained in:
Alexander Schwartz 2024-03-06 17:32:16 +01:00 committed by Alexander Schwartz
parent d5a613cd6b
commit fa12b14a32

View file

@ -159,12 +159,21 @@ The valid values for log levels are `debug`, `info`, `warn`, `error`, and `fatal
===== The Email Event Listener ===== The Email Event Listener
The Email Event Listener sends an email to the user's account when an event occurs and supports the following events: The Email Event Listener sends a message to the user's email address when an event occurs and supports the following events:
* Login Error. * Login Error.
* Update Password. * Update Password.
* Update Time-based One-time Password (TOTP). * Update Time-based One-time Password (TOTP).
* Remove Time-based One-time Password (TOTP). * Remove One-time Password (OTP).
The following conditions need to be met for an email to be sent:
* User has an email address.
* User's email address is marked as verified.
.Prerequisites
* Realm's email settings configured.
.Procedure .Procedure