docs: explain gateway auth action pattern#1331
Open
memleakd wants to merge 1 commit into
Open
Conversation
Signed-off-by: memleakd <121398829+memleakd@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This follows up on #1328 and @datamweb's idea about using a conditional action as a small gateway for more complex login flows.
I tried the pattern locally, and it works: an app can register one login action, let
appliesTo()decide whether it should run for the user, and then handle the actual method choice inside the action's normalshow()/handle()/verify()flow.This PR adds that pattern to the Authentication Actions docs.
The important detail is that the gateway should still behave like one Shield action. It should return one type from
getType()and use that as the pending action identity. The available methods, like email or SMS, should be handled inside the gateway instead of becoming separate action identities.This documents a useful app-level pattern for people who need one login action to offer more than one verification method.
Checklist: