Package com.yubico.webauthn

Class AssertionRequest.AssertionRequestBuilder

java.lang.Object

com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder

Enclosing class:

AssertionRequest

public static class AssertionRequest.AssertionRequestBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AssertionRequest.AssertionRequestBuilder.MandatoryStages

Method Summary

Modifier and Type	Method	Description
AssertionRequest	build()
AssertionRequest.AssertionRequestBuilder	publicKeyCredentialRequestOptions(@NonNull PublicKeyCredentialRequestOptions publicKeyCredentialRequestOptions)	An object that can be serialized to JSON and passed as the publicKey argument to navigator.credentials.get().
String	toString()
AssertionRequest.AssertionRequestBuilder	userHandle(@NonNull Optional<ByteArray> userHandle)	The user handle of the user to authenticate, if the user has already been identified.
AssertionRequest.AssertionRequestBuilder	userHandle(ByteArray userHandle)	The user handle of the user to authenticate, if the user has already been identified.
AssertionRequest.AssertionRequestBuilder	username(@NonNull Optional<String> username)	The username of the user to authenticate, if the user has already been identified.
AssertionRequest.AssertionRequestBuilder	username(String username)	The username of the user to authenticate, if the user has already been identified.

Methods inherited from class java.lang.Object

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

Method Details

username

public AssertionRequest.AssertionRequestBuilder username(@NonNull
 @NonNull Optional<String> username)

The username of the user to authenticate, if the user has already been identified.

This is mutually exclusive with userHandle(ByteArray); setting this to non-empty will unset userHandle(ByteArray).

If this is empty, this indicates that this is a request for an assertion by a client-side-discoverable credential (passkey). Identification of the user is therefore deferred until the response is received.

See Also:

• Passkey in passkeys.dev reference

username

public AssertionRequest.AssertionRequestBuilder username(String username)

The username of the user to authenticate, if the user has already been identified.

This is mutually exclusive with userHandle(ByteArray); setting this to non- null will unset userHandle(ByteArray).

If this is empty, this indicates that this is a request for an assertion by a client-side-discoverable credential (passkey). Identification of the user is therefore deferred until the response is received.

See Also:

• Passkey in passkeys.dev reference

userHandle

public AssertionRequest.AssertionRequestBuilder userHandle(@NonNull
 @NonNull Optional<ByteArray> userHandle)

The user handle of the user to authenticate, if the user has already been identified.

This is mutually exclusive with username(String); setting this to non-empty will unset username(String).

If both this and username(String) are empty, this indicates that this is a request for an assertion by a client-side-discoverable credential (passkey). Identification of the user is therefore deferred until the response is received.

See Also:

• Passkey in passkeys.dev reference

userHandle

public AssertionRequest.AssertionRequestBuilder userHandle(ByteArray userHandle)

The user handle of the user to authenticate, if the user has already been identified.

This is mutually exclusive with username(String); setting this to non-null will unset username(String).

If both this and username(String) are empty, this indicates that this is a request for an assertion by a client-side-discoverable credential (passkey). Identification of the user is therefore deferred until the response is received.

See Also:

• Passkey in passkeys.dev reference

publicKeyCredentialRequestOptions

public AssertionRequest.AssertionRequestBuilder publicKeyCredentialRequestOptions(@NonNull
 @NonNull PublicKeyCredentialRequestOptions publicKeyCredentialRequestOptions)

An object that can be serialized to JSON and passed as the publicKey argument to navigator.credentials.get().

Returns:

this.

build

public AssertionRequest build()

toString

public String toString()

Overrides:

toString in class Object