From a960d0d8fa09138495b2656a309457ef18979518 Mon Sep 17 00:00:00 2001 From: Lex Cao Date: Tue, 16 Jan 2024 01:13:16 +0800 Subject: [PATCH] Add upgrading docs for changes to send-verify-email API Closes #26146. Signed-off-by: Lex Cao --- .../topics/keycloak/changes-24_0_0.adoc | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/documentation/upgrading/topics/keycloak/changes-24_0_0.adoc b/docs/documentation/upgrading/topics/keycloak/changes-24_0_0.adoc index cfdc6a71c5a5..3a9c9a9a8c94 100644 --- a/docs/documentation/upgrading/topics/keycloak/changes-24_0_0.adoc +++ b/docs/documentation/upgrading/topics/keycloak/changes-24_0_0.adoc @@ -190,3 +190,33 @@ To revert the change for an installation, use a custom Infinispan XML configurat ---- ---- + += The Admin send-verify-email API now uses the same email verification template + +---- +PUT /admin/realms/{realm}/users/{id}/send-verify-email +---- + +In this release, the API will use the `email-verification.ftl` template instead of `executeActions.ftl`. + +.Before upgrading +---- +Perform the following action(s): Verify Email +---- + +.After upgrading +---- +Confirm validity of e-mail address email@example.org. +---- + +If you have customized the `executeActions.ftl` template to modify how users verify their email using this API, ensure that you transfer your modifications to the new template. + +A new parameter called `lifespan` will be introduced to allow overriding of the default lifespan value (12 hours). + +If you prefer the previous behavior, use the `execute-actions-email` API as follows. + +---- +PUT /admin/realms/{realm}/users/{id}/execute-actions-email + +["VERIFY_EMAIL"] +----