Merge ActionTokenStoreProvider and SingleUseObjectProvider (#1697)

This commit is contained in:
Martin Kanis 2022-10-13 09:39:06 +02:00 committed by GitHub
parent 09aa20f9c8
commit 0ed325ef89
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 9 deletions

View file

@ -12,7 +12,7 @@ include::topics/providers.adoc[]
ifeval::[{project_community}==true]
include::topics/extensions.adoc[]
include::topics/auth-spi.adoc[]
include::topics/action-token-spi.adoc[]
include::topics/action-token-handler-spi.adoc[]
include::topics/events.adoc[]
include::topics/saml-role-mappings-spi.adoc[]
endif::[]

View file

@ -1,5 +1,5 @@
[[_action_token_spi]]
== Action Token SPI
[[_action_token_handler_spi]]
== Action Token Handler SPI
An action token is a special instance of Json Web Token (JWT) that permits its bearer to perform some actions, e. g. to
reset a password or validate e-mail address. They are usually sent to users in form of a link that points to an endpoint
@ -13,7 +13,7 @@ processing action tokens for a particular realm.
* Confirm linking of an account with account in external identity provider
In addition to that, it is possible to implement any functionality that initiates or modifies authentication session
using action token SPI, details of which are described in the text below.
using action token handler SPI, details of which are described in the text below.
[[_action_token_anatomy]]
=== Anatomy of action token
@ -157,7 +157,7 @@ start a fresh one by calling `startFreshAuthenticationSession(token, context)`.
The token handler also determines via method `canUseTokenRepeatedly(token, context)` whether the token would be
invalidated after it is used and authentication completes. Note that if you would have a flow utilizing multiple action
token, only the last token would be invalidated. In that case, you should use
`org.keycloak.models.ActionTokenStoreProvider` in action token handler to invalidate the used tokens manually.
`org.keycloak.models.SingleUseObjectProvider` in action token handler to invalidate the used tokens manually.
+
Default implementation of most of the `ActionTokenHandler` methods is the
`org.keycloak.authentication.actiontoken.AbstractActionTokenHander` abstract class in `keycloak-services` module. The

View file

@ -67,8 +67,8 @@ endif::[]
:developerguide_link: {project_doc_base_url}/server_development/
:developerguide_link_latest: {project_doc_base_url_latest}/server_development/
:developerguide_deploying_themes: {developerguide_link}#deploying-themes
:developerguide_actiontoken_name: Action Token SPI
:developerguide_actiontoken_link: {developerguide_link}#_action_token_spi
:developerguide_actiontoken_name: Action Token Handler SPI
:developerguide_actiontoken_link: {developerguide_link}#_action_token_handler_spi
:developerguide_jsproviders_name: JavaScript Providers
:developerguide_jsproviders_link: {developerguide_link}#_script_providers
:gettingstarted_name: Getting Started Guide

View file

@ -66,8 +66,8 @@
:developerguide_name: Server Developer Guide
:developerguide_link: {project_doc_base_url}/server_developer_guide/
:developerguide_deploying_themes: {developerguide_link}#deploying-themes
:developerguide_actiontoken_name: Action Token SPI
:developerguide_actiontoken_link: {developerguide_link}#_action_token_spi
:developerguide_actiontoken_name: Action Token Handler SPI
:developerguide_actiontoken_link: {developerguide_link}#_action_token_handler_spi
:developerguide_jsproviders_name: JavaScript Providers
:developerguide_jsproviders_link: {developerguide_link}#_script_providers
:gettingstarted_name: Getting Started Guide