Package com.yubico.webauthn.data

Class AuthenticatorSelectionCriteria

java.lang.Object

com.yubico.webauthn.data.AuthenticatorSelectionCriteria

public final class AuthenticatorSelectionCriteria
extends Object

This class may be used to specify requirements regarding authenticator attributes.

See Also:

• §5.4.4. Authenticator Selection Criteria (dictionary AuthenticatorSelectionCriteria)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder

Method Summary

Modifier and Type	Method	Description
static AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	builder()
boolean	equals(Object o)
Optional<AuthenticatorAttachment>	getAuthenticatorAttachment()	If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).
Optional<ResidentKeyRequirement>	getResidentKey()	Specifies the extent to which the Relying Party desires to create a client-side discoverable credential (passkey).
Optional<UserVerificationRequirement>	getUserVerification()	Describes the Relying Party's requirements regarding user verification for the navigator.credentials.create() operation.
int	hashCode()
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getAuthenticatorAttachment

public Optional<AuthenticatorAttachment> getAuthenticatorAttachment()

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

getResidentKey

public Optional<ResidentKeyRequirement> getResidentKey()

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.

See Also:

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

getUserVerification

public Optional<UserVerificationRequirement> getUserVerification()

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.

See Also:

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

builder

public static AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder builder()

toBuilder

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object