A user's preference for using SMS message multi-factor authentication (MFA). Turns SMS MFA on and off, and can set SMS as preferred when other MFA options are available. You can't turn off SMS MFA for any of your users when MFA is required in your user pool; you can only set the type that your user prefers.
Inheritance Hierarchy
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class SMSMfaSettingsType
The SMSMfaSettingsType type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
SMSMfaSettingsType() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Enabled | System.Boolean |
Gets and sets the property Enabled. Specifies whether SMS message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. |
|
|
PreferredMfa | System.Boolean |
Gets and sets the property PreferredMfa. Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5