cognitoidentityprovider_set_user_pool_mfa_config: Set the user pool multi-factor authentication (MFA)...

Description Usage Arguments Request syntax

View source: R/cognitoidentityprovider_operations.R

Description

Set the user pool multi-factor authentication (MFA) configuration.

Usage

1
2
cognitoidentityprovider_set_user_pool_mfa_config(UserPoolId,
  SmsMfaConfiguration, SoftwareTokenMfaConfiguration, MfaConfiguration)

Arguments

UserPoolId

[required] The user pool ID.

SmsMfaConfiguration

The SMS text message MFA configuration.

SoftwareTokenMfaConfiguration

The software token MFA configuration.

MfaConfiguration

The MFA configuration. Valid values include:

  • OFF MFA will not be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc$set_user_pool_mfa_config(
  UserPoolId = "string",
  SmsMfaConfiguration = list(
    SmsAuthenticationMessage = "string",
    SmsConfiguration = list(
      SnsCallerArn = "string",
      ExternalId = "string"
    )
  ),
  SoftwareTokenMfaConfiguration = list(
    Enabled = TRUE|FALSE
  ),
  MfaConfiguration = "OFF"|"ON"|"OPTIONAL"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.