libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Add upgrading docs for changes to send-verify-email API

Browse source 
Closes #26146.

Signed-off-by: Lex Cao <lexcao@foxmail.com>
This commit is contained in:
Lex Cao 2024-01-16 01:13:16 +08:00 committed by Marek Posolda
parent 0eb1932df0
commit a960d0d8fa
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/documentation/upgrading/topics/keycloak/changes-24_0_0.adoc
View file

@ -190,3 +190,33 @@ To revert the change for an installation, use a custom Infinispan XML configurat
----
<metrics names-as-tags="false" />
----
= 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"]
----