forked from keycloak/keycloak
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add upgrading docs for changes to send-verify-email API
Closes keycloak#26146. Signed-off-by: Lex Cao <[email protected]>
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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"] | ||
---- |