Admin Set User Mfa Preference

cognitoidentityprovider_admin_set_user_mfa_preference

R Documentation

The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred

Description

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_admin_set_user_mfa_preference(SMSMfaSettings,
  SoftwareTokenMfaSettings, Username, UserPoolId)

Arguments

SMSMfaSettings

The SMS text message MFA settings.

SoftwareTokenMfaSettings

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

Username

[required] 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.

UserPoolId

[required] The user pool ID.

Value

An empty list.

Request syntax

svc$admin_set_user_mfa_preference(
  SMSMfaSettings = list(
    Enabled = TRUE|FALSE,
    PreferredMfa = TRUE|FALSE
  ),
  SoftwareTokenMfaSettings = list(
    Enabled = TRUE|FALSE,
    PreferredMfa = TRUE|FALSE
  ),
  Username = "string",
  UserPoolId = "string"
)