AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the AdminSetUserMFAPreference operation. 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.

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

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.AdminSetUserMFAPreferenceRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public class AdminSetUserMFAPreferenceRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The AdminSetUserMFAPreferenceRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property SMSMfaSettings Amazon.CognitoIdentityProvider.Model.SMSMfaSettingsType

Gets and sets the property SMSMfaSettings.

The SMS text message MFA settings.

Public Property SoftwareTokenMfaSettings Amazon.CognitoIdentityProvider.Model.SoftwareTokenMfaSettingsType

Gets and sets the property SoftwareTokenMfaSettings.

The time-based one-time password software token MFA settings.

Public Property 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 username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The user pool ID.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5