Get User Pool Mfa Config

cognitoidentityprovider_get_user_pool_mfa_config

R Documentation

Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA)

Description

Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA). This operation describes the following:

• The WebAuthn relying party (RP) ID and user-verification settings.

• The required, optional, or disabled state of MFA for all user pool users.

• The message templates for email and SMS MFA.

• The enabled or disabled state of time-based one-time password (TOTP) MFA.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_get_user_pool_mfa_config(UserPoolId)

Arguments

UserPoolId

[required] The ID of the user pool where you want to query WebAuthn and MFA configuration.

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