paws.security.identity (version 0.1.7)

cognitoidentityprovider_admin_set_user_mfa_preference: Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred

Description

Sets the user\'s multi-factor authentication (MFA) preference, including which MFA options 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_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 user pool username or alias.

UserPoolId

[required] The user pool ID.

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"
)