-
Notifications
You must be signed in to change notification settings - Fork 968
Introduces <TaskSetupMfa /> component and the setup-mfa session task
#3022
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: core-3
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- Introduced a new guide for building a custom flow for the setup MFA session task. - Updated links in the session tasks table and MFA requirement documentation to point to the new guide. - Made minor formatting adjustments in various documentation files for clarity.
2bcab1d to
f5f8475
Compare
<TaskSetupMfa /> component and the setup-mfa session task<TaskSetupMfa /> component and the setup-mfa session task
|
I've posted my docs review!
TODO:
|
|
@SarahSoutoul @manovotny I've finished my docs review, could I get more eyes on this before we merge into core 3 branch :) |
docs/guides/development/custom-flows/authentication/email-password-mfa.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if it's an issue or not, but all of our other images for components are png.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@octoper could you re-export from figma or wherever you got it as a png instead of jpg? just for the sake of consistency in our images
Have left a very minor docs review, and some comments/ discussion pts! @alexisintech |
| - The layout page that checks if the user is signed in | ||
| - The page where users can manage their account, including their MFA settings | ||
| - The page where users can add TOTP MFA | ||
| - The layout page that checks if the user is signed in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a list - these fragment sentences don't finish any sentence so they don't get full stops
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair. I only added them cause they were on the other fragments of that page for consistency.
|
@SarahSoutoul replied and addressed everything, think this is now just waiting on vaggelis to update the image :) thanks for the review! |



🔎 Previews:
What does this solve?
This PR adds documentation for the new
setup-mfasession task feature, which allows applications to require all users to set up multi-factor authentication after signing in or signing up. This simplifies the MFA enforcement flow by using Clerk's session task system instead of requiring developers to write custom middleware.What changed?
clerk/javascript#7626
New Documentation:
<TaskSetupMfa />with examples for Next.js, React, React Router, TanStack React Start, and JavaScript SDKtask-propertiespartial to be used across the Task components for their# Propertiessectionssetup-mfatask to the session tasks table and guidesUpdated Documentation:
/auth-strategies/sign-up-sign-in-optionsto be the source of truth for setting up MFA and enabling the Require setting./force-mfaguide in favor of this sectionsetup-mfatasksetup-mfatask/manage-sms-based-mfaand/manage-totp-based-mfaguides. Now it's just the/manage-mfaguide. This creates a single source of truth for a custom flow for managing MFA.ensured the flows handle completing a user's setup-mfa task