Container for the parameters to the AdminSetUserMFAPreference operation. Sets the user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
This operation doesn't reset an existing TOTP MFA for a user. To register a new TOTP factor for a user, make an AssociateSoftwareToken request. For more information, see TOTP software token MFA.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.AdminSetUserMFAPreferenceRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class AdminSetUserMFAPreferenceRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The AdminSetUserMFAPreferenceRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AdminSetUserMFAPreferenceRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
EmailMfaSettings | Amazon.CognitoIdentityProvider.Model.EmailMfaSettingsType |
Gets and sets the property EmailMfaSettings. User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, advanced security features must be active in your user pool. |
|
|
SMSMfaSettings | Amazon.CognitoIdentityProvider.Model.SMSMfaSettingsType |
Gets and sets the property SMSMfaSettings. User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available. |
|
|
SoftwareTokenMfaSettings | Amazon.CognitoIdentityProvider.Model.SoftwareTokenMfaSettingsType |
Gets and sets the property SoftwareTokenMfaSettings. User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. |
|
|
Username | System.String |
Gets and sets the property Username.
The username of the user that you want to query or modify. The value of this parameter
is typically your user's username, but it can be any of their alias attributes. If
|
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool where you want to set a user's MFA preferences. |
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