com.yubico.webauthn.data

Class PublicKeyCredentialCreationOptions

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialCreationOptions

public final class PublicKeyCredentialCreationOptions
extends java.lang.Object

Parameters for a call to navigator.credentials.create().

See Also:

§5.4. Options for Credential Creation (dictionary PublicKeyCredentialCreationOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder

Method Summary

Modifier and Type	Method and Description
static PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages	builder()
boolean	equals(java.lang.Object o)
@NonNull AttestationConveyancePreference	getAttestation() Intended for use by Relying Parties that wish to express their preference for attestation conveyance.
@NonNull java.util.Optional<AuthenticatorSelectionCriteria>	getAuthenticatorSelection() Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.
@NonNull ByteArray	getChallenge() A challenge intended to be used for generating the newly created credential’s attestation object.
@NonNull java.util.Optional<java.util.Set<PublicKeyCredentialDescriptor>>	getExcludeCredentials() Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator.
@NonNull RegistrationExtensionInputs	getExtensions() Additional parameters requesting additional processing by the client and authenticator.
@NonNull java.util.List<PublicKeyCredentialParameters>	getPubKeyCredParams() Information about the desired properties of the credential to be created.
@NonNull RelyingPartyIdentity	getRp() Contains data about the Relying Party responsible for the request.
@NonNull java.util.Optional<java.lang.Long>	getTimeout() A time, in milliseconds, that the caller is willing to wait for the call to complete.
@NonNull UserIdentity	getUser() Contains data about the user account for which the Relying Party is requesting attestation.
int	hashCode()
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages builder()

toBuilder

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder toBuilder()

getRp

@NonNull
public @NonNull RelyingPartyIdentity getRp()

Contains data about the Relying Party responsible for the request.

Its value's id member specifies the RP ID the credential should be scoped to. If omitted, its value will be set by the client. See RelyingPartyIdentity for further details.

getUser

@NonNull
public @NonNull UserIdentity getUser()

Contains data about the user account for which the Relying Party is requesting attestation.

getChallenge

@NonNull
public @NonNull ByteArray getChallenge()

A challenge intended to be used for generating the newly created credential’s attestation object. See the §13.1 Cryptographic Challenges security consideration.

getPubKeyCredParams

@NonNull
public @NonNull java.util.List<PublicKeyCredentialParameters> getPubKeyCredParams()

Information about the desired properties of the credential to be created.

The sequence is ordered from most preferred to least preferred. The client makes a best-effort to create the most preferred credential that it can.

getTimeout

@NonNull
public @NonNull java.util.Optional<java.lang.Long> getTimeout()

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.

getExcludeCredentials

@NonNull
public @NonNull java.util.Optional<java.util.Set<PublicKeyCredentialDescriptor>> getExcludeCredentials()

Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The client is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.

getAuthenticatorSelection

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

Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.

getAttestation

@NonNull
public @NonNull AttestationConveyancePreference getAttestation()

Intended for use by Relying Parties that wish to express their preference for attestation conveyance. The default is AttestationConveyancePreference.NONE.

getExtensions

@NonNull
public @NonNull RegistrationExtensionInputs getExtensions()

Additional parameters requesting additional processing by the client and authenticator.

For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in §9 WebAuthn Extensions; consult the IANA "WebAuthn Extension Identifier" registry established by [WebAuthn-Registries] for an up-to-date list of registered WebAuthn Extensions.

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