Package 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 tonavigator.credentials.create()
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.java.util.Optional<AuthenticatorSelectionCriteria>
getAuthenticatorSelection()
@NonNull ByteArray
getChallenge()
A challenge intended to be used for generating the newly created credential’s attestation object.java.util.Optional<java.util.Set<PublicKeyCredentialDescriptor>>
getExcludeCredentials()
@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.java.util.Optional<java.lang.Long>
getTimeout()
@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()
-
-
-
Method Detail
-
getTimeout
public java.util.Optional<java.lang.Long> getTimeout()
-
getExcludeCredentials
public java.util.Optional<java.util.Set<PublicKeyCredentialDescriptor>> getExcludeCredentials()
-
getAuthenticatorSelection
public java.util.Optional<AuthenticatorSelectionCriteria> getAuthenticatorSelection()
-
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. SeeRelyingPartyIdentity
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.
-
getAttestation
@NonNull public @NonNull AttestationConveyancePreference getAttestation()
Intended for use by Relying Parties that wish to express their preference for attestation conveyance. The default isAttestationConveyancePreference.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 classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-