Package com.yubico.webauthn

Class StartRegistrationOptions

java.lang.Object

com.yubico.webauthn.StartRegistrationOptions

public final class StartRegistrationOptions
extends java.lang.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(java.lang.Object o)
java.util.Optional<AuthenticatorSelectionCriteria>	getAuthenticatorSelection()	Constraints on what kind of authenticator the user is allowed to use to create the credential.
@NonNull RegistrationExtensionInputs	getExtensions()	Extension inputs for this registration operation.
java.util.Optional<java.lang.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()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getAuthenticatorSelection

public java.util.Optional<AuthenticatorSelectionCriteria> getAuthenticatorSelection()

Constraints on what kind of authenticator the user is allowed to use to create the credential.

getTimeout

public java.util.Optional<java.lang.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.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object