Package com.yubico.webauthn.data

Class AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder

java.lang.Object

com.yubico.webauthn.data.AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder

Enclosing class:

AuthenticatorSelectionCriteria

public static class AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	authenticatorAttachment(@NonNull java.util.Optional<AuthenticatorAttachment> authenticatorAttachment)	If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	authenticatorAttachment(AuthenticatorAttachment authenticatorAttachment)	If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).
AuthenticatorSelectionCriteria	build()
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	requireResidentKey(boolean requireResidentKey)	Deprecated. Use residentKey instead.
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	residentKey(ResidentKeyRequirement residentKey)	Specifies the extent to which the Relying Party desires to create a client-side discoverable credential.
java.lang.String	toString()
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	userVerification(UserVerificationRequirement userVerification)	Describes the Relying Party's requirements regarding user verification for the navigator.credentials.create() operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

authenticatorAttachment

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder authenticatorAttachment(@NonNull
                                                                                                    @NonNull java.util.Optional<AuthenticatorAttachment> authenticatorAttachment)

If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).

authenticatorAttachment

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder authenticatorAttachment(AuthenticatorAttachment authenticatorAttachment)

If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).

requireResidentKey

@Deprecated
public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder requireResidentKey(boolean requireResidentKey)

Deprecated.

Use residentKey instead.

This member is retained for backwards compatibility with WebAuthn Level 1 and, for historical reasons, its naming retains the deprecated “resident” terminology for discoverable credentials.

requireResidentKey(true) is an alias of residentKey(REQUIRED) .

requireResidentKey(false) is an alias of residentKey(DISCOURAGED) .

See Also:

residentKey(ResidentKeyRequirement)

residentKey

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder residentKey(ResidentKeyRequirement residentKey)

Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated “resident” terminology.

The default is ResidentKeyRequirement.DISCOURAGED.

Returns:

this.

See Also:

ResidentKeyRequirement, §5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement), Client-side discoverable Credential

userVerification

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder userVerification(UserVerificationRequirement userVerification)

Describes the Relying Party's requirements regarding user verification for the navigator.credentials.create() operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.

Returns:

this.

build

public AuthenticatorSelectionCriteria build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object