feat: add Multi-Factor Authentication (MFA) support #1014
Open
gyaneshgouraw-okta wants to merge 4 commits intomainfrom
Open
feat: add Multi-Factor Authentication (MFA) support #1014gyaneshgouraw-okta wants to merge 4 commits intomainfrom
gyaneshgouraw-okta wants to merge 4 commits intomainfrom
Conversation
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.
Summary
Adds comprehensive MFA support by exposing the MFA client from
@auth0/auth0-spa-jsthrough theuseAuth0()hook. Enables React applications to implement MFA enrollment, challenge, and verification flows for all authenticator types (OTP, SMS, Voice, Email, Push).Changes
Core Implementation
src/auth0-context.tsx&src/auth0-provider.tsxmfaproperty toAuth0ContextInterfaceexposingMfaApiClientAvailable Methods:
getAuthenticators(mfaToken)- List enrolled authenticatorsenroll(params)- Enroll new authenticators (OTP, SMS, Voice, Email, Push)challenge(params)- Initiate MFA challengesverify(params)- Verify with OTP, OOB code, or recovery codegetEnrollmentFactors(mfaToken)- Get available enrollment factorsDocumentation (
EXAMPLES.md)Added comprehensive MFA guide covering:
MfaRequiredErrorTesting (
__tests__/mfa.test.tsx)__mocks__/@auth0/auth0-spa-js.tsxUsage Example
Breaking Changes
None. Backward compatible, additive change only.
Related Documentation
@auth0/auth0-spa-jsMFA API