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

Class WebAuthnConfigurationType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.WebAuthnConfigurationType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WebAuthnConfigurationType.Builder,WebAuthnConfigurationType>

@Generated("software.amazon.awssdk:codegen")
public final class WebAuthnConfigurationType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WebAuthnConfigurationType.Builder,WebAuthnConfigurationType>

Settings for multi-factor authentication (MFA) with passkey, or webauthN, biometric and security-key devices in a user pool. Configures the following:

• Configuration at the user-pool level for whether you want to require passkey configuration as an MFA factor, or include it as a choice.

• The user pool relying-party ID. This is the user pool domain that user's passkey providers should trust as a receiver of passkey authentication.

• The providers that you want to allow as origins for passkey authentication.

This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebAuthnConfigurationType.Builder

Method Summary

Modifier and Type	Method	Description
static WebAuthnConfigurationType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WebAuthnConfigurationType.Builder>	serializableBuilderClass()
WebAuthnConfigurationType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UserVerificationType	userVerification()	When required, users can only register and sign in users with passkeys that are capable of user verification.
String	userVerificationAsString()	When required, users can only register and sign in users with passkeys that are capable of user verification.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

relyingPartyId

public final 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.

Returns:

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.

userVerification

public final 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.

If the service returns an enum value that is not available in the current SDK version, userVerification will return UserVerificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userVerificationAsString().

Returns:

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.

See Also:

UserVerificationType

userVerificationAsString

public final String userVerificationAsString()

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.

If the service returns an enum value that is not available in the current SDK version, userVerification will return UserVerificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userVerificationAsString().

Returns:

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.

See Also:

UserVerificationType

toBuilder

public WebAuthnConfigurationType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WebAuthnConfigurationType.Builder,WebAuthnConfigurationType>

builder

public static WebAuthnConfigurationType.Builder builder()

serializableBuilderClass

public static Class<? extends WebAuthnConfigurationType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo