Package com.yubico.webauthn

Class StartAssertionOptions.StartAssertionOptionsBuilder

java.lang.Object

com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder

Enclosing class:

StartAssertionOptions

public static class StartAssertionOptions.StartAssertionOptionsBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
StartAssertionOptions	build()
StartAssertionOptions.StartAssertionOptionsBuilder	extensions(@NonNull AssertionExtensionInputs extensions)	Extension inputs for this authentication operation.
StartAssertionOptions.StartAssertionOptionsBuilder	timeout(long timeout)	The value for PublicKeyCredentialRequestOptions.getTimeout() for this authentication operation.
StartAssertionOptions.StartAssertionOptionsBuilder	timeout(@NonNull java.util.Optional<java.lang.Long> timeout)	The value for PublicKeyCredentialRequestOptions.getTimeout() for this authentication operation.
java.lang.String	toString()
StartAssertionOptions.StartAssertionOptionsBuilder	username(@NonNull java.lang.String username)	The username of the user to authenticate, if the user has already been identified.
StartAssertionOptions.StartAssertionOptionsBuilder	username(@NonNull java.util.Optional<java.lang.String> username)	The username of the user to authenticate, if the user has already been identified.
StartAssertionOptions.StartAssertionOptionsBuilder	userVerification(@NonNull UserVerificationRequirement userVerification)	The value for PublicKeyCredentialRequestOptions.getUserVerification() for this authentication operation.
StartAssertionOptions.StartAssertionOptionsBuilder	userVerification(@NonNull java.util.Optional<UserVerificationRequirement> userVerification)	The value for PublicKeyCredentialRequestOptions.getUserVerification() for this authentication operation.

Methods inherited from class java.lang.Object

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

Method Detail

username

public StartAssertionOptions.StartAssertionOptionsBuilder username(@NonNull
                                                                   @NonNull java.util.Optional<java.lang.String> username)

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

If this is absent, that implies a first-factor authentication operation - meaning identification of the user is deferred until after receiving the response from the client.

The default is empty (absent).

See Also:

Client-side-resident credential

username

public StartAssertionOptions.StartAssertionOptionsBuilder username(@NonNull
                                                                   @NonNull java.lang.String username)

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

If this is absent, that implies a first-factor authentication operation - meaning identification of the user is deferred until after receiving the response from the client.

The default is empty (absent).

See Also:

Client-side-resident credential

userVerification

public StartAssertionOptions.StartAssertionOptionsBuilder userVerification(@NonNull
                                                                           @NonNull java.util.Optional<UserVerificationRequirement> userVerification)

The value for PublicKeyCredentialRequestOptions.getUserVerification() for this authentication operation.

The default is UserVerificationRequirement.PREFERRED.

userVerification

public StartAssertionOptions.StartAssertionOptionsBuilder userVerification(@NonNull
                                                                           @NonNull UserVerificationRequirement userVerification)

The value for PublicKeyCredentialRequestOptions.getUserVerification() for this authentication operation.

The default is UserVerificationRequirement.PREFERRED.

timeout

public StartAssertionOptions.StartAssertionOptionsBuilder timeout(@NonNull
                                                                  @NonNull java.util.Optional<java.lang.Long> timeout)

The value for PublicKeyCredentialRequestOptions.getTimeout() for this authentication operation.

This library does not take the timeout into account in any way, other than passing it through to the PublicKeyCredentialRequestOptions so it can be used as an argument to navigator.credentials.get() on the client side.

The default is empty.

timeout

public StartAssertionOptions.StartAssertionOptionsBuilder timeout(long timeout)

The value for PublicKeyCredentialRequestOptions.getTimeout() for this authentication operation.

This library does not take the timeout into account in any way, other than passing it through to the PublicKeyCredentialRequestOptions so it can be used as an argument to navigator.credentials.get() on the client side.

The default is empty.

extensions

public StartAssertionOptions.StartAssertionOptionsBuilder extensions(@NonNull
                                                                     @NonNull AssertionExtensionInputs extensions)

Extension inputs for this authentication operation.

If RelyingParty.getAppId() is set, RelyingParty.startAssertion(StartAssertionOptions) will overwrite any appId extension input set herein.

The default specifies no extension inputs.

Returns:

this.

build

public StartAssertionOptions build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object