Add custom MFA factor docs and announcement blog - #3159
Open
atharvadeosthale wants to merge 1 commit into
Open
Conversation
Add a Custom MFA factor page under Auth, covering the full flow: create a challenge with the custom factor, read the code with a Server SDK, deliver it from a function, and complete the challenge. Add the announcement and tutorial blog post for the same feature. Link the new page from the MFA page intro and from a Custom tab in the Create challenge step, and add the sidebar entry. The blog cover is not created yet and points at a placeholder path.
Appwrite WebsiteProject ID: Website (appwrite/website)Project ID: Tip Git integration provides automatic deployments with optional PR comments |
Contributor
Greptile SummaryThe PR documents the new custom MFA challenge factor and adds an announcement/tutorial blog post.
Confidence Score: 5/5The documentation changes appear safe to merge once the explicitly pending blog cover asset is supplied. No concrete unacknowledged build, rendering, navigation, security, or documentation defect remains supported by the available repository evidence. Important Files Changed
Reviews (1): Last reviewed commit: "feat(docs): add custom MFA factor docs a..." | Re-trigger Greptile |
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.


What does this PR do?
Documents the new
customMFA challenge factor, and adds the announcement blog post for it.The custom factor lets a developer deliver a second factor through any channel. Appwrite generates and verifies the code. A new server-only method,
users.getMFAChallenge, hands the code to a function or backend, which sends it through WhatsApp, a voice call, an internal system, or any other provider.Docs
/docs/products/auth/custom-mfa. Covers the flow end to end: create the challenge, call your function, read the code with a Server SDK, deliver it, complete the challenge. Includes the security requirements./docs/products/auth/mfa: the intro names the custom factor and links out, and the Create challenge step gains a Custom tab.Blog
/blog/post/custom-mfa-factor. Announcement and tutorial in one.Test plan
The flow was exercised end to end against a development instance before the pages were written. Verified in four combinations: a Node function and a Rust function, each driven from a vanilla web client and a React client.
Each run checked that:
code401401factorsarray gainscustom401Every SDK snippet on both pages comes from generated SDK examples or from verified method signatures, not from hand-writing.
Both pages render locally.
Notes for the reviewer
cover:points at/images/blog/custom-mfa-factor/cover.avifand needs the real asset before merge.users.getMFAChallengeappears once the specs package is republished and the pin inpackage.jsonis bumped. Nothing in this PR depends on that.