Package com.webauthn4j.data

Class AuthenticationParameters

java.lang.Object

com.webauthn4j.data.CoreAuthenticationParameters

com.webauthn4j.data.AuthenticationParameters

All Implemented Interfaces:

Serializable

public class AuthenticationParameters
extends CoreAuthenticationParameters

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationParameters(@NonNull ServerProperty serverProperty, @NonNull Authenticator authenticator, boolean userVerificationRequired)	Deprecated. Deprecated as allowCredentials verification was introduced from WebAuthn Level2.
AuthenticationParameters(@NonNull ServerProperty serverProperty, @NonNull Authenticator authenticator, boolean userVerificationRequired, boolean userPresenceRequired)	Deprecated. Deprecated as allowCredentials verification was introduced from WebAuthn Level2.
AuthenticationParameters(@NonNull ServerProperty serverProperty, @NonNull Authenticator authenticator, @Nullable List<byte[]> allowCredentials, boolean userVerificationRequired)	AuthenticationParameters constructor
AuthenticationParameters(@NonNull ServerProperty serverProperty, @NonNull Authenticator authenticator, @Nullable List<byte[]> allowCredentials, boolean userVerificationRequired, boolean userPresenceRequired)	AuthenticationParameters constructor

Method Summary

Modifier and Type	Method	Description
@NonNull Authenticator	getAuthenticator()
@NonNull ServerProperty	getServerProperty()

Methods inherited from class com.webauthn4j.data.CoreAuthenticationParameters

equals, getAllowCredentials, hashCode, isUserPresenceRequired, isUserVerificationRequired, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationParameters

public AuthenticationParameters(@NonNull ServerProperty serverProperty,
 @NonNull Authenticator authenticator,
 @Nullable List<byte[]> allowCredentials,
 boolean userVerificationRequired,
 boolean userPresenceRequired)

AuthenticationParameters constructor

Parameters:

serverProperty - server property

allowCredentials - allowed credentialId list. If all credentialId(s) are allowed, pass null

userVerificationRequired - true if user verification is required. Otherwise, false

userPresenceRequired - true if user presence is required. Otherwise, false

AuthenticationParameters

public AuthenticationParameters(@NonNull ServerProperty serverProperty,
 @NonNull Authenticator authenticator,
 @Nullable List<byte[]> allowCredentials,
 boolean userVerificationRequired)

AuthenticationParameters constructor

Parameters:

serverProperty - server property

allowCredentials - allowed credentialId list. If all credentialId(s) are allowed, pass null

userVerificationRequired - true if user verification is required. Otherwise, false

AuthenticationParameters

@Deprecated
public AuthenticationParameters(@NonNull ServerProperty serverProperty,
 @NonNull Authenticator authenticator,
 boolean userVerificationRequired,
 boolean userPresenceRequired)

Deprecated.

Deprecated as allowCredentials verification was introduced from WebAuthn Level2.

AuthenticationParameters

@Deprecated
public AuthenticationParameters(@NonNull ServerProperty serverProperty,
 @NonNull Authenticator authenticator,
 boolean userVerificationRequired)

Deprecated.

Deprecated as allowCredentials verification was introduced from WebAuthn Level2.

Method Details

getServerProperty

public @NonNull ServerProperty getServerProperty()

Overrides:

getServerProperty in class CoreAuthenticationParameters

getAuthenticator

public @NonNull Authenticator getAuthenticator()

Overrides:

getAuthenticator in class CoreAuthenticationParameters