From fa12b14a32416eadb3bcf64f906488c45f9ae1e8 Mon Sep 17 00:00:00 2001 From: Alexander Schwartz Date: Wed, 6 Mar 2024 17:32:16 +0100 Subject: [PATCH] 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 Signed-off-by: andymunro <48995441+andymunro@users.noreply.github.com> --- .../server_admin/topics/events/login.adoc | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/documentation/server_admin/topics/events/login.adoc b/docs/documentation/server_admin/topics/events/login.adoc index 6471c4ff2b..99e0e4e72a 100644 --- a/docs/documentation/server_admin/topics/events/login.adoc +++ b/docs/documentation/server_admin/topics/events/login.adoc @@ -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 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. * Update Password. * 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