feat(Auth): Update docs to reflect email MFA support #8465
Merged
+36
−72
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
osama-rizk
requested review from
a team,
harsh62 and
hdworld11
as code owners
4 tasks
soberm
approved these changes
Nov 10, 2025
sarayev
approved these changes
Nov 10, 2025
osama-rizk
added a commit
to aws-amplify/amplify-backend
that referenced
this pull request
Nov 10, 2025
## Problem This PR adds support for email-based multi-factor authentication (MFA) to the Amplify Auth construct. Previously, the Auth construct only supported SMS and TOTP MFA methods, limiting authentication options for applications that prefer email-based verification. Issue number, if available: - aws-amplify/amplify-ui#6590 - #2159 ## Changes • **Auth Construct**: Added email MFA configuration support in construct.ts with new type definitions in types.ts • **API Updates**: Extended public API to include email MFA options with TypeScript types • **Client Configuration**: Updated all client config schema versions (v1, v1.1-v1.4) to support email MFA settings • **Documentation**: Updated API.md and README.md with email MFA usage examples • **Test Coverage**: Added comprehensive unit tests for email MFA functionality **Corresponding docs PR, if applicable:** - aws-amplify/docs#8465 ## Validation • **Unit Tests**: Added 56 lines of test coverage in construct.test.ts validating email MFA configuration and behavior • **Manual testing**: I tested on a amplify sample app which is linked locally with amplify-backend. I set the email MFA to true and false and checked it updates correctly in the Cognito user pool ## Checklist - [ ] If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change. - [ ] If this PR requires a change to the [Project Architecture README](../PROJECT_ARCHITECTURE.md), I have included that update in this PR. - [ ] If this PR requires a docs update, I have linked to that docs PR above. - [ ] If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the `run-e2e` label set. _By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license._
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 of changes:
Updated documentation to reflect native email MFA support in Amplify backend. Removed outdated callouts stating email MFA is not supported with
defineAuthand added configuration examples showing how to enable email MFA natively.Changes made:
defineAuthemail: truein multifactor settingsRelated GitHub issue #, if available:
Addresses the completion of aws-amplify/amplify-backend#3036 which added native email MFA support.
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.