Class StartRegistrationOptions.StartRegistrationOptionsBuilder
- Enclosing class:
- StartRegistrationOptions
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class -
Method Summary
Modifier and TypeMethodDescriptionauthenticatorSelection(@NonNull Optional<AuthenticatorSelectionCriteria> authenticatorSelection) 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.authenticatorSelection(AuthenticatorSelectionCriteria authenticatorSelection) 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.build()extensions(@NonNull RegistrationExtensionInputs extensions) Extension inputs for this registration operation.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 registration operation.Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this registration operation.Zero or more hints, in descending order of preference, to guide the user agent in interacting with the user during this registration operation.timeout(long timeout) The value forPublicKeyCredentialCreationOptions.getTimeout()for this registration operation.The value forPublicKeyCredentialCreationOptions.getTimeout()for this registration operation.toString()user(@NonNull UserIdentity user) Identifiers for the user creating a credential.
-
Method Details
-
authenticatorSelection
public StartRegistrationOptions.StartRegistrationOptionsBuilder authenticatorSelection(@NonNull @NonNull Optional<AuthenticatorSelectionCriteria> authenticatorSelection) 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. -
authenticatorSelection
public StartRegistrationOptions.StartRegistrationOptionsBuilder authenticatorSelection(AuthenticatorSelectionCriteria authenticatorSelection) 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. -
timeout
public StartRegistrationOptions.StartRegistrationOptionsBuilder timeout(@NonNull @NonNull Optional<Long> timeout) The value forPublicKeyCredentialCreationOptions.getTimeout()for this registration operation.This library does not take the timeout into account in any way, other than passing it through to the
PublicKeyCredentialCreationOptionsso it can be used as an argument tonavigator.credentials.create()on the client side.The default is empty.
-
timeout
The value forPublicKeyCredentialCreationOptions.getTimeout()for this registration operation.This library does not take the timeout into account in any way, other than passing it through to the
PublicKeyCredentialCreationOptionsso it can be used as an argument tonavigator.credentials.create()on the client side.The default is empty.
-
hints
public StartRegistrationOptions.StartRegistrationOptionsBuilder 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 registration operation.Setting this property multiple times overwrites any value set previously.
For example, the
PublicKeyCredentialHint.SECURITY_KEYhint may be used to ask the client to emphasize the option of registering with an external security key, or thePublicKeyCredentialHint.CLIENT_DEVICEhint 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
StartRegistrationOptions.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
PublicKeyCredentialCreationOptionsso they can be used in the argument tonavigator.credentials.create()on the client side.The default is empty.
-
hints
public StartRegistrationOptions.StartRegistrationOptionsBuilder 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 registration operation.Setting this property multiple times overwrites any value set previously.
For example, the
PublicKeyCredentialHint.SECURITY_KEYhint may be used to ask the client to emphasize the option of registering with an external security key, or thePublicKeyCredentialHint.CLIENT_DEVICEhint 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
StartRegistrationOptions.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
PublicKeyCredentialCreationOptionsso they can be used in the argument tonavigator.credentials.create()on the client side.The default is empty.
-
hints
public StartRegistrationOptions.StartRegistrationOptionsBuilder 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 registration operation.Setting this property multiple times overwrites any value set previously.
For example, the
PublicKeyCredentialHint.SECURITY_KEYhint may be used to ask the client to emphasize the option of registering with an external security key, or thePublicKeyCredentialHint.CLIENT_DEVICEhint 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
StartRegistrationOptions.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
PublicKeyCredentialCreationOptionsso they can be used in the argument tonavigator.credentials.create()on the client side.The default is empty.
-
user
public StartRegistrationOptions.StartRegistrationOptionsBuilder user(@NonNull @NonNull UserIdentity user) Identifiers for the user creating a credential.- Returns:
this.
-
extensions
public StartRegistrationOptions.StartRegistrationOptionsBuilder extensions(@NonNull @NonNull RegistrationExtensionInputs extensions) Extension inputs for this registration operation.- Returns:
this.
-
build
-
toString
-