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 Object

Method Summary

Modifier and Type	Method	Description
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	authenticatorAttachment(@NonNull 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	residentKey(ResidentKeyRequirement residentKey)	Specifies the extent to which the Relying Party desires to create a client-side discoverable credential (passkey).
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 Details

authenticatorAttachment

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder authenticatorAttachment(@NonNull
 @NonNull 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).

residentKey

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder residentKey(ResidentKeyRequirement residentKey)

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

When this is set, PublicKeyCredentialCreationOptions.toCredentialsCreateJson() will also emit a requireResidentKey member for backwards compatibility with WebAuthn Level 1. It will be set to true if this is set to REQUIRED and false if this is set to anything else. When this is not set, a requireResidentKey member will not be emitted.

When not set, the default in the browser is ResidentKeyRequirement.DISCOURAGED.

By default, this is not set.

Returns:

this.

See Also:

• ResidentKeyRequirement
• §5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement)
• Client-side discoverable Credential
• Passkey in passkeys.dev reference

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.

By default, this is not set. When not set, the default in the browser is UserVerificationRequirement.PREFERRED.

Returns:

this.

See Also:

• UserVerificationRequirement
• §5.8.6. User Verification Requirement Enumeration (enum UserVerificationRequirement)
• User Verification

build

public AuthenticatorSelectionCriteria build()

toString

public String toString()

Overrides:

toString in class Object