Package com.yubico.webauthn.data

Class PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder

Enclosing class:

PublicKeyCredentialRequestOptions

public static class PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages

Method Summary

Modifier and Type	Method	Description
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	allowCredentials(@NonNull Optional<List<PublicKeyCredentialDescriptor>> allowCredentials)	A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	allowCredentials(List<PublicKeyCredentialDescriptor> allowCredentials)	A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).
PublicKeyCredentialRequestOptions	build()
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	challenge(@NonNull ByteArray challenge)	A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	extensions(@NonNull AssertionExtensionInputs extensions)	Additional parameters requesting additional processing by the client and authenticator.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	hints(@NonNull PublicKeyCredentialHint... hints)	Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this authentication operation.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	hints(@NonNull String... hints)	Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this authentication operation.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	hints(@NonNull List<String> hints)	Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this authentication operation.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	rpId(@NonNull Optional<String> rpId)	Specifies the relying party identifier claimed by the caller.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	rpId(String rpId)	Specifies the relying party identifier claimed by the caller.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	timeout(long timeout)	Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	timeout(@NonNull Optional<Long> timeout)	Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
String	toString()
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	userVerification(UserVerificationRequirement userVerification)	Describes the Relying Party's requirements regarding user verification for the navigator.credentials.get() operation.

Methods inherited from class java.lang.Object

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

Method Details

timeout

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder timeout(@NonNull
 @NonNull Optional<Long> timeout)

Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.

This is treated as a hint, and MAY be overridden by the client.

timeout

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder timeout(long timeout)

Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.

This is treated as a hint, and MAY be overridden by the client.

hints

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder hints(@NonNull
 @NonNull String... hints)

Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this authentication operation.

Setting this property multiple times overwrites any value set previously.

For example, the PublicKeyCredentialHint.SECURITY_KEY hint may be used to ask the client to emphasize the option of authenticating with an external security key, or the PublicKeyCredentialHint.CLIENT_DEVICE hint may be used to ask the client to emphasize the option of authenticating a built-in passkey provider.

These hints are not requirements, and do not bind the user-agent, but may guide it in providing the best experience by using contextual information about the request.

Hints MAY contradict information contained in PublicKeyCredentialDescriptor.getTransports(). When this occurs, the hints take precedence.

This library does not take these hints into account in any way, other than passing them through so they can be used in the argument to navigator.credentials.get() on the client side.

The default is empty.

See Also:

• PublicKeyCredentialHint
• StartAssertionOptions.getHints()
• PublicKeyCredentialRequestOptions.getHints()
• hints(List)
• hints(PublicKeyCredentialHint...)
• PublicKeyCredentialRequestOptions.hints
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

hints

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder hints(@NonNull
 @NonNull PublicKeyCredentialHint... hints)

Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this authentication operation.

Setting this property multiple times overwrites any value set previously.

For example, the PublicKeyCredentialHint.SECURITY_KEY hint may be used to ask the client to emphasize the option of authenticating with an external security key, or the PublicKeyCredentialHint.CLIENT_DEVICE hint may be used to ask the client to emphasize the option of authenticating a built-in passkey provider.

These hints are not requirements, and do not bind the user-agent, but may guide it in providing the best experience by using contextual information about the request.

Hints MAY contradict information contained in PublicKeyCredentialDescriptor.getTransports(). When this occurs, the hints take precedence.

This library does not take these hints into account in any way, other than passing them through so they can be used in the argument to navigator.credentials.get() on the client side.

The default is empty.

See Also:

• PublicKeyCredentialHint
• StartAssertionOptions.getHints()
• PublicKeyCredentialRequestOptions.getHints()
• hints(List)
• hints(String...)
• PublicKeyCredentialRequestOptions.hints
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

hints

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder hints(@NonNull
 @NonNull List<String> hints)

Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this authentication operation.

Setting this property multiple times overwrites any value set previously.

For example, the PublicKeyCredentialHint.SECURITY_KEY hint may be used to ask the client to emphasize the option of authenticating with an external security key, or the PublicKeyCredentialHint.CLIENT_DEVICE hint may be used to ask the client to emphasize the option of authenticating a built-in passkey provider.

These hints are not requirements, and do not bind the user-agent, but may guide it in providing the best experience by using contextual information about the request.

Hints MAY contradict information contained in PublicKeyCredentialDescriptor.getTransports(). When this occurs, the hints take precedence.

This library does not take these hints into account in any way, other than passing them through so they can be used in the argument to navigator.credentials.get() on the client side.

The default is empty.

See Also:

• PublicKeyCredentialHint
• StartAssertionOptions.getHints()
• PublicKeyCredentialRequestOptions.getHints()
• hints(String...)
• hints(PublicKeyCredentialHint...)
• PublicKeyCredentialRequestOptions.hints
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

rpId

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder rpId(@NonNull
 @NonNull Optional<String> rpId)

Specifies the relying party identifier claimed by the caller.

If omitted, its value will be set by the client.

rpId

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder rpId(String rpId)

Specifies the relying party identifier claimed by the caller.

If omitted, its value will be set by the client.

allowCredentials

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder allowCredentials(@NonNull
 @NonNull Optional<List<PublicKeyCredentialDescriptor>> allowCredentials)

A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).

allowCredentials

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder allowCredentials(List<PublicKeyCredentialDescriptor> allowCredentials)

A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).

challenge

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder challenge(@NonNull
 @NonNull ByteArray challenge)

A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion. See the §13.1 Cryptographic Challenges security consideration.

Returns:

this.

userVerification

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder userVerification(UserVerificationRequirement userVerification)

Describes the Relying Party's requirements regarding user verification for the navigator.credentials.get() 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.

Returns:

this.

See Also:

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

extensions

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder extensions(@NonNull
 @NonNull AssertionExtensionInputs extensions)

Additional parameters requesting additional processing by the client and authenticator.

For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension.

Returns:

this.

build

public PublicKeyCredentialRequestOptions build()

toString

public String toString()

Overrides:

toString in class Object