Get User Pool Mfa Config

cognitoidentityprovider_get_user_pool_mfa_config

R Documentation

Gets the user pool multi-factor authentication (MFA) configuration¶

Description¶

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

Usage¶

cognitoidentityprovider_get_user_pool_mfa_config(UserPoolId)

Arguments¶

UserPoolId: [required] The user pool ID.

Value¶

A list with the following syntax:

list(
  SmsMfaConfiguration = list(
    SmsAuthenticationMessage = "string",
    SmsConfiguration = list(
      SnsCallerArn = "string",
      ExternalId = "string",
      SnsRegion = "string"
    )
  ),
  SoftwareTokenMfaConfiguration = list(
    Enabled = TRUE|FALSE
  ),
  EmailMfaConfiguration = list(
    Message = "string",
    Subject = "string"
  ),
  MfaConfiguration = "OFF"|"ON"|"OPTIONAL",
  WebAuthnConfiguration = list(
    RelyingPartyId = "string",
    UserVerification = "required"|"preferred"
  )
)

Request syntax¶

svc$get_user_pool_mfa_config(
  UserPoolId = "string"
)