Class: Aws::CognitoIdentityProvider::Types::SetUserMFAPreferenceRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:access_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_token ⇒ String

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

  • (String) 


10437
10438
10439
10440
10441
10442
10443
10444
10445
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10437

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :email_mfa_settings,
  :web_authn_mfa_settings,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#email_mfa_settings ⇒ Types::EmailMfaSettingsType

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

Returns:



10437
10438
10439
10440
10441
10442
10443
10444
10445
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10437

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :email_mfa_settings,
  :web_authn_mfa_settings,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#sms_mfa_settings ⇒ Types::SMSMfaSettingsType

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

Returns:



10437
10438
10439
10440
10441
10442
10443
10444
10445
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10437

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :email_mfa_settings,
  :web_authn_mfa_settings,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#software_token_mfa_settings ⇒ Types::SoftwareTokenMfaSettingsType

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. Users must register a TOTP authenticator before they set this as their preferred MFA method.

Returns:



10437
10438
10439
10440
10441
10442
10443
10444
10445
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10437

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :email_mfa_settings,
  :web_authn_mfa_settings,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end

#web_authn_mfa_settings ⇒ Types::WebAuthnMfaSettingsType

User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the FactorConfiguration of your user pool WebAuthnConfiguration must be MULTI_FACTOR_WITH_USER_VERIFICATION. To activate this setting, your user pool must be in the Essentials tier or higher.

Returns:



10437
10438
10439
10440
10441
10442
10443
10444
10445
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10437

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :email_mfa_settings,
  :web_authn_mfa_settings,
  :access_token)
  SENSITIVE = [:access_token]
  include Aws::Structure
end