Learn R Programming

paws.security.identity (version 0.7.0)

cognitoidentityprovider_set_user_pool_mfa_config: Sets the user pool multi-factor authentication (MFA) configuration

Description

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

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_set_user_pool_mfa_config/ for full documentation.

Usage

cognitoidentityprovider_set_user_pool_mfa_config(
  UserPoolId,
  SmsMfaConfiguration = NULL,
  SoftwareTokenMfaConfiguration = NULL,
  MfaConfiguration = NULL
)

Arguments

UserPoolId

[required] The user pool ID.

SmsMfaConfiguration

The SMS text message MFA configuration.

SoftwareTokenMfaConfiguration

The software token MFA configuration.

MfaConfiguration

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

  • OFF MFA won't 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 activated.