Package com.yubico.webauthn

Class StartRegistrationOptions

java.lang.Object

com.yubico.webauthn.StartRegistrationOptions

public final class StartRegistrationOptions
extends Object

Parameters for RelyingParty.startRegistration(StartRegistrationOptions).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StartRegistrationOptions.StartRegistrationOptionsBuilder

Method Summary

Modifier and Type	Method	Description
static StartRegistrationOptions.StartRegistrationOptionsBuilder.MandatoryStages	builder()
boolean	equals(Object o)
Optional<AuthenticatorSelectionCriteria>	getAuthenticatorSelection()	Constraints on what kind of authenticator the user is allowed to use to create the credential, and on features that authenticator must or should support.
@NonNull RegistrationExtensionInputs	getExtensions()	Extension inputs for this registration operation.
List<String>	getHints()	Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this registration operation.
Optional<Long>	getTimeout()	The value for PublicKeyCredentialCreationOptions.getTimeout() for this registration operation.
@NonNull UserIdentity	getUser()	Identifiers for the user creating a credential.
int	hashCode()
StartRegistrationOptions.StartRegistrationOptionsBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getAuthenticatorSelection

public Optional<AuthenticatorSelectionCriteria> getAuthenticatorSelection()

Constraints on what kind of authenticator the user is allowed to use to create the credential, and on features that authenticator must or should support.

getTimeout

public Optional<Long> getTimeout()

The value for PublicKeyCredentialCreationOptions.getTimeout() for this registration operation.

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

The default is empty.

builder

public static StartRegistrationOptions.StartRegistrationOptionsBuilder.MandatoryStages builder()

toBuilder

public StartRegistrationOptions.StartRegistrationOptionsBuilder toBuilder()

getUser

@NonNull
public @NonNull UserIdentity getUser()

Identifiers for the user creating a credential.

getExtensions

@NonNull
public @NonNull RegistrationExtensionInputs getExtensions()

Extension inputs for this registration operation.

getHints

public List<String> getHints()

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

For example, the PublicKeyCredentialHint.SECURITY_KEY hint may be used to ask the client to emphasize the option of registering with an external security key, or the PublicKeyCredentialHint.CLIENT_DEVICE hint may be used to ask the client to emphasize the option of registering 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 preferences in getAuthenticatorSelection(). When this occurs, the hints take precedence.

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

The default is empty.

See Also:

• PublicKeyCredentialHint
• StartRegistrationOptions.StartRegistrationOptionsBuilder.hints(List)
• StartRegistrationOptions.StartRegistrationOptionsBuilder.hints(String...)
• StartRegistrationOptions.StartRegistrationOptionsBuilder.hints(PublicKeyCredentialHint...)
• PublicKeyCredentialCreationOptions.hints
• §5.8.7. User-agent Hints Enumeration (enum PublicKeyCredentialHints)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object