Class: Aws::CognitoIdentityProvider::Types::GetUserPoolMfaConfigResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#email_mfa_configuration ⇒ Types::EmailMfaConfigType

Shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the [ Essentials tier] or higher.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html

Returns:



6378
6379
6380
6381
6382
6383
6384
6385
6386
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6378

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#mfa_configuration ⇒ String

Displays the state of multi-factor authentication (MFA) as on, off, or optional. When ‘ON`, all users must set up MFA before they can sign in. When `OPTIONAL`, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose `OPTIONAL`.

When ‘MfaConfiguration` is `OPTIONAL`, managed login doesn’t automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

Returns:

  • (String) 


6378
6379
6380
6381
6382
6383
6384
6385
6386
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6378

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sms_mfa_configuration ⇒ Types::SmsMfaConfigType

Shows user pool configuration for SMS message MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.

Returns:



6378
6379
6380
6381
6382
6383
6384
6385
6386
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6378

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#software_token_mfa_configuration ⇒ Types::SoftwareTokenMfaConfigType

Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

Returns:



6378
6379
6380
6381
6382
6383
6384
6385
6386
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6378

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#web_authn_configuration ⇒ Types::WebAuthnConfigurationType

Shows user pool configuration for sign-in with passkey authenticators like biometric devices and security keys. Passkeys are not eligible MFA factors. They are instead an eligible primary sign-in factor for [choice-based authentication], or the ‘USER_AUTH` flow.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/authentication-flows-selection-sdk.html#authentication-flows-selection-choice

Returns:



6378
6379
6380
6381
6382
6383
6384
6385
6386
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6378

class GetUserPoolMfaConfigResponse < Struct.new(
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration,
  :web_authn_configuration)
  SENSITIVE = []
  include Aws::Structure
end