Skip to content

Commit

Permalink
Add upgrading docs for changes to send-verify-email API
Browse files Browse the repository at this point in the history
Closes keycloak#26146.

Signed-off-by: Lex Cao <[email protected]>
  • Loading branch information
lexcao authored and mposolda committed Jan 18, 2024
1 parent 0eb1932 commit a960d0d
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/documentation/upgrading/topics/keycloak/changes-24_0_0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 protected].
----

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"]
----

0 comments on commit a960d0d

Please sign in to comment.