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

Interface WebAuthnConfigurationType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WebAuthnConfigurationType.Builder,WebAuthnConfigurationType>, SdkBuilder<WebAuthnConfigurationType.Builder,WebAuthnConfigurationType>, SdkPojo
Enclosing class:
WebAuthnConfigurationType
@Mutable @NotThreadSafe public static interface WebAuthnConfigurationType.Builder extends SdkPojo, CopyableBuilder<WebAuthnConfigurationType.Builder,WebAuthnConfigurationType>

  • Method Details

    • relyingPartyId

      WebAuthnConfigurationType.Builder relyingPartyId(String relyingPartyId)

      Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.

      Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:

      • The user pool is configured for passkey authentication.

      • The user pool has a custom domain, whether or not it also has a prefix domain.

      • Your application performs authentication with managed login or the classic hosted UI.

      Parameters:
      relyingPartyId - Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.

      Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:

      • The user pool is configured for passkey authentication.

      • The user pool has a custom domain, whether or not it also has a prefix domain.

      • Your application performs authentication with managed login or the classic hosted UI.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userVerification

      WebAuthnConfigurationType.Builder userVerification(String userVerification)

      When required, users can only register and sign in users with passkeys that are capable of user verification. When preferred, your user pool doesn't require the use of authenticators with user verification but encourages it.

      Parameters:
      userVerification - When required, users can only register and sign in users with passkeys that are capable of user verification. When preferred, your user pool doesn't require the use of authenticators with user verification but encourages it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userVerification

      WebAuthnConfigurationType.Builder userVerification(UserVerificationType userVerification)

      When required, users can only register and sign in users with passkeys that are capable of user verification. When preferred, your user pool doesn't require the use of authenticators with user verification but encourages it.

      Parameters:
      userVerification - When required, users can only register and sign in users with passkeys that are capable of user verification. When preferred, your user pool doesn't require the use of authenticators with user verification but encourages it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • factorConfiguration

      WebAuthnConfigurationType.Builder factorConfiguration(String factorConfiguration)

      Sets whether passkeys can be used as multi-factor authentication (MFA). When set to MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user verification satisfies MFA requirements. When set to SINGLE_FACTOR or not set, passkeys are a single authentication factor. To activate this setting, your user pool must be in the Essentials tier or higher.

      Parameters:
      factorConfiguration - Sets whether passkeys can be used as multi-factor authentication (MFA). When set to MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user verification satisfies MFA requirements. When set to SINGLE_FACTOR or not set, passkeys are a single authentication factor. 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.
      See Also:

    • factorConfiguration

      WebAuthnConfigurationType.Builder factorConfiguration(WebAuthnFactorConfigurationType factorConfiguration)

      Sets whether passkeys can be used as multi-factor authentication (MFA). When set to MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user verification satisfies MFA requirements. When set to SINGLE_FACTOR or not set, passkeys are a single authentication factor. To activate this setting, your user pool must be in the Essentials tier or higher.

      Parameters:
      factorConfiguration - Sets whether passkeys can be used as multi-factor authentication (MFA). When set to MULTI_FACTOR_WITH_USER_VERIFICATION, passkey authentication with user verification satisfies MFA requirements. When set to SINGLE_FACTOR or not set, passkeys are a single authentication factor. 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.
      See Also: