Learn R Programming

paws.security.identity (version 0.1.8)

cognitoidentityprovider_set_user_mfa_preference: Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred

Description

Set the user\'s multi-factor authentication (MFA) method preference, including which MFA factors are enabled 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 enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.

Usage

cognitoidentityprovider_set_user_mfa_preference(SMSMfaSettings,
  SoftwareTokenMfaSettings, AccessToken)

Arguments

SMSMfaSettings

The SMS text message multi-factor authentication (MFA) settings.

SoftwareTokenMfaSettings

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

AccessToken

[required] The access token for the user.

Request syntax

svc$set_user_mfa_preference(
  SMSMfaSettings = list(
    Enabled = TRUE|FALSE,
    PreferredMfa = TRUE|FALSE
  ),
  SoftwareTokenMfaSettings = list(
    Enabled = TRUE|FALSE,
    PreferredMfa = TRUE|FALSE
  ),
  AccessToken = "string"
)