Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface GetUserPoolMfaConfigResponse.Builder

    • Method Detail

      • smsMfaConfiguration

        GetUserPoolMfaConfigResponse.Builder smsMfaConfiguration​(SmsMfaConfigType smsMfaConfiguration)

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

        Parameters:
        smsMfaConfiguration - Shows user pool configuration for SMS message MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • softwareTokenMfaConfiguration

        GetUserPoolMfaConfigResponse.Builder softwareTokenMfaConfiguration​(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)

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

        Parameters:
        softwareTokenMfaConfiguration - Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • emailMfaConfiguration

        GetUserPoolMfaConfigResponse.Builder emailMfaConfiguration​(EmailMfaConfigType emailMfaConfiguration)

        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.

        Parameters:
        emailMfaConfiguration - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • mfaConfiguration

        GetUserPoolMfaConfigResponse.Builder mfaConfiguration​(String mfaConfiguration)

        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.

        Parameters:
        mfaConfiguration - 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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserPoolMfaType, UserPoolMfaType

      • mfaConfiguration

        GetUserPoolMfaConfigResponse.Builder mfaConfiguration​(UserPoolMfaType mfaConfiguration)

        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.

        Parameters:
        mfaConfiguration - 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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        UserPoolMfaType, UserPoolMfaType

      • webAuthnConfiguration

        GetUserPoolMfaConfigResponse.Builder webAuthnConfiguration​(WebAuthnConfigurationType webAuthnConfiguration)

        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.

        Parameters:
        webAuthnConfiguration - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.