StartAssertionOptions.StartAssertionOptionsBuilder (webauthn-server-core 2.4.1-RC1 API)

java.lang.Object
- com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder

Enclosing class:: StartAssertionOptions

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`userHandle(ByteArray userHandle)` The user handle of the user to authenticate, if the user has already been identified.
`StartAssertionOptions.StartAssertionOptionsBuilder`	`userHandle(@NonNull java.util.Optional<ByteArray> userHandle)` The user handle 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`	`username(java.lang.String username)` The username of the user to authenticate, if the user has already been identified.
`StartAssertionOptions.StartAssertionOptionsBuilder`	`userVerification(@NonNull java.util.Optional<UserVerificationRequirement> userVerification)` The value for `PublicKeyCredentialRequestOptions.getUserVerification()` for this authentication operation.
`StartAssertionOptions.StartAssertionOptionsBuilder`	`userVerification(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.
    Mutually exclusive with userHandle(Optional). Setting this to a present value will set userHandle(Optional) to empty.
    If this or userHandle(Optional) is present, then RelyingParty.startAssertion(StartAssertionOptions) will set PublicKeyCredentialRequestOptions.getAllowCredentials() to the list of that user's credentials.
    If this and StartAssertionOptions.getUserHandle() are both 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:
    
    username(String), userHandle(Optional), userHandle(ByteArray), Client-side-discoverable credential
  - username
```
public StartAssertionOptions.StartAssertionOptionsBuilder username(java.lang.String username)
```
    The username of the user to authenticate, if the user has already been identified.
    Mutually exclusive with userHandle(Optional). Setting this to a non-null value will set userHandle(Optional) to empty.
    If this or userHandle(Optional) is present, then RelyingParty.startAssertion(StartAssertionOptions) will set PublicKeyCredentialRequestOptions.getAllowCredentials() to the list of that user's credentials.
    If this and StartAssertionOptions.getUserHandle() are both 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:
    
    username(Optional), userHandle(Optional), userHandle(ByteArray), Client-side-discoverable credential
  - userHandle
```
public StartAssertionOptions.StartAssertionOptionsBuilder userHandle(@NonNull
                                                                     @NonNull java.util.Optional<ByteArray> userHandle)
```
    The user handle of the user to authenticate, if the user has already been identified.
    Mutually exclusive with username(Optional). Setting this to a present value will set username(Optional) to empty.
    If this or username(Optional) is present, then RelyingParty.startAssertion(StartAssertionOptions) will set PublicKeyCredentialRequestOptions.getAllowCredentials() to the list of that user's credentials.
    If this and StartAssertionOptions.getUsername() are both 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:
    
    username(String), username(Optional), userHandle(ByteArray), User Handle, Client-side-discoverable credential
  - userHandle
```
public StartAssertionOptions.StartAssertionOptionsBuilder userHandle(ByteArray userHandle)
```
    The user handle of the user to authenticate, if the user has already been identified.
    Mutually exclusive with username(Optional). Setting this to a non-null value will set username(Optional) to empty.
    If this or username(Optional) is present, then RelyingParty.startAssertion(StartAssertionOptions) will set PublicKeyCredentialRequestOptions.getAllowCredentials() to the list of that user's credentials.
    If this and StartAssertionOptions.getUsername() are both 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:
    
    username(String), username(Optional), userHandle(Optional), Client-side-discoverable credential
  - userVerification
```
public StartAssertionOptions.StartAssertionOptionsBuilder userVerification(@NonNull
                                                                           @NonNull java.util.Optional<UserVerificationRequirement> userVerification)
```
    The value for PublicKeyCredentialRequestOptions.getUserVerification() for this authentication operation.
    If set to UserVerificationRequirement.REQUIRED, then RelyingParty.finishAssertion(FinishAssertionOptions) will enforce that user verificationwas performed in this authentication ceremony.
    The default is UserVerificationRequirement.PREFERRED.
  - userVerification
```
public StartAssertionOptions.StartAssertionOptionsBuilder userVerification(UserVerificationRequirement userVerification)
```
    The value for PublicKeyCredentialRequestOptions.getUserVerification() for this authentication operation.
    If set to UserVerificationRequirement.REQUIRED, then RelyingParty.finishAssertion(FinishAssertionOptions) will enforce that user verificationwas performed in this authentication ceremony.
    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

Class StartAssertionOptions.StartAssertionOptionsBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

username

username

userHandle

userHandle

userVerification

userVerification

timeout

timeout

extensions

build

toString