EmailMfaSettingsType
User preferences for multi-factor authentication with email messages. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.
This data type is a request parameter of SetUserMFAPreference and AdminSetUserMFAPreference.
Contents
- Enabled
-
Specifies whether email message MFA is active for a user. When the value of this parameter is
Enabled, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.Type: Boolean
Required: No
- PreferredMfa
-
Specifies whether email message MFA is the user's preferred method.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
