cognitoidentityprovider_admin_set_user_mfa_preference: Sets the user's multi-factor authentication (MFA) preference

Description Usage Arguments Request syntax

View source: R/cognitoidentityprovider_operations.R

Description

Sets the user's multi-factor authentication (MFA) preference.

Usage

1
2
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
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"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.