akasha

Interface PublicKeyCredentialCreationOptions.Builder

All Superinterfaces:

PublicKeyCredentialCreationOptions

Enclosing interface:

PublicKeyCredentialCreationOptions

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="PublicKeyCredentialCreationOptions")
public static interface PublicKeyCredentialCreationOptions.Builder
extends PublicKeyCredentialCreationOptions

The PublicKeyCredentialCreationOptions dictionary of the Web Authentication API holds options passed to navigators.credentials.create() in order to create a PublicKeyCredential.

See Also:

PublicKeyCredentialCreationOptions - MDN, PublicKeyCredentialCreationOptions dictionary - Web Authentication: An API for accessing Public Key Credentials Level 1

Nested Class Summary

Nested classes/interfaces inherited from interface akasha.PublicKeyCredentialCreationOptions

PublicKeyCredentialCreationOptions.Builder

Method Summary

Modifier and Type	Method and Description
default PublicKeyCredentialCreationOptions.Builder	attestation(java.lang.String attestation) attestation is an optional property of the PublicKeyCredentialCreationOptions dictionary.
default PublicKeyCredentialCreationOptions.Builder	authenticatorSelection(AuthenticatorSelectionCriteria authenticatorSelection) authenticatorSelection, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an object giving criteria to filter out the authenticators to be used for the creation operation.
default PublicKeyCredentialCreationOptions.Builder	challenge(BufferSource challenge) The challenge property of the PublicKeyCredentialCreationOptions dictionary is a BufferSource used as a cryptographic challenge.
default PublicKeyCredentialCreationOptions.Builder	excludeCredentials(JsArray<PublicKeyCredentialDescriptor> excludeCredentials) excludeCredentials, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an Array whose elements are descriptors for the public keys already existing for a given user.
default PublicKeyCredentialCreationOptions.Builder	excludeCredentials(PublicKeyCredentialDescriptor... excludeCredentials) excludeCredentials, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an Array whose elements are descriptors for the public keys already existing for a given user.
default PublicKeyCredentialCreationOptions.Builder	extensions(AuthenticationExtensionsClientInputs extensions) extensions, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an object providing the client extensions and their input values.
default PublicKeyCredentialCreationOptions.Builder	pubKeyCredParams(JsArray<PublicKeyCredentialParameters> pubKeyCredParams) The pubKeyCredParams property of the PublicKeyCredentialCreationOptions dictionary is an Array whose elements are objects describing the desired features of the credential to be created.
default PublicKeyCredentialCreationOptions.Builder	pubKeyCredParams(PublicKeyCredentialParameters... pubKeyCredParams) The pubKeyCredParams property of the PublicKeyCredentialCreationOptions dictionary is an Array whose elements are objects describing the desired features of the credential to be created.
default PublicKeyCredentialCreationOptions.Builder	rp(PublicKeyCredentialRpEntity rp) The rp property of the PublicKeyCredentialCreationOptions dictionary is an object describing the relying party which requested the credential creation (via navigator.credentials.create()).
default PublicKeyCredentialCreationOptions.Builder	timeout(int timeout) The timeout property, of the PublicKeyCredentialCreationOptions dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the creation operation.
default PublicKeyCredentialCreationOptions.Builder	user(PublicKeyCredentialUserEntity user) The user property of the PublicKeyCredentialCreationOptions dictionary is an object describing the user account for which the credentials are generated (via navigator.credentials.create()).

Methods inherited from interface akasha.PublicKeyCredentialCreationOptions

attestation, authenticatorSelection, challenge, create, create, excludeCredentials, extensions, pubKeyCredParams, rp, setAttestation, setAuthenticatorSelection, setChallenge, setExcludeCredentials, setExcludeCredentials, setExtensions, setPubKeyCredParams, setPubKeyCredParams, setRp, setTimeout, setUser, timeout, user

Method Detail

attestation

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder attestation(@Nonnull
                                                                                    java.lang.String attestation)

attestation is an optional property of the PublicKeyCredentialCreationOptions dictionary. This is a string whose value indicates the preference regarding the attestation transport, between the authenticator, the client and the relying party.

See Also:

PublicKeyCredentialCreationOptions.attestation - MDN, attestation - Web Authentication: An API for accessing Public Key Credentials Level 1

authenticatorSelection

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder authenticatorSelection(@Nonnull
                                                                                               AuthenticatorSelectionCriteria authenticatorSelection)

authenticatorSelection, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an object giving criteria to filter out the authenticators to be used for the creation operation.

See Also:

PublicKeyCredentialCreationOptions.authenticatorSelection - MDN, authenticatorSelection - Web Authentication: An API for accessing Public Key Credentials Level 1

challenge

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder challenge(@Nonnull
                                                                                  BufferSource challenge)

The challenge property of the PublicKeyCredentialCreationOptions dictionary is a BufferSource used as a cryptographic challenge. This is randomly generated then sent from the relying party's server. This value (among other client data) will be signed by the authenticator, using its private key, and must be sent back for verification to the server as part of AuthenticatorAttestationResponse.attestationObject.

See Also:

PublicKeyCredentialCreationOptions.challenge - MDN, challenge - Web Authentication: An API for accessing Public Key Credentials Level 1

excludeCredentials

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder excludeCredentials(@Nonnull
                                                                                           JsArray<PublicKeyCredentialDescriptor> excludeCredentials)

excludeCredentials, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an Array whose elements are descriptors for the public keys already existing for a given user. This is provided by the relying party's server if it wants to prevent creation of new credentials for an existing user.

See Also:

PublicKeyCredentialCreationOptions.excludeCredentials - MDN, excludeCredentials - Web Authentication: An API for accessing Public Key Credentials Level 1

excludeCredentials

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder excludeCredentials(@Nonnull
                                                                                           PublicKeyCredentialDescriptor... excludeCredentials)

excludeCredentials, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an Array whose elements are descriptors for the public keys already existing for a given user. This is provided by the relying party's server if it wants to prevent creation of new credentials for an existing user.

See Also:

PublicKeyCredentialCreationOptions.excludeCredentials - MDN, excludeCredentials - Web Authentication: An API for accessing Public Key Credentials Level 1

extensions

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder extensions(@Nonnull
                                                                                   AuthenticationExtensionsClientInputs extensions)

extensions, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an object providing the client extensions and their input values.

See Also:

PublicKeyCredentialCreationOptions.extensions - MDN, extensions - Web Authentication: An API for accessing Public Key Credentials Level 1

pubKeyCredParams

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder pubKeyCredParams(@Nonnull
                                                                                         JsArray<PublicKeyCredentialParameters> pubKeyCredParams)

The pubKeyCredParams property of the PublicKeyCredentialCreationOptions dictionary is an Array whose elements are objects describing the desired features of the credential to be created. These objects define the type of public-key and the algorithm used for cryptographic signature operations.

See Also:

PublicKeyCredentialCreationOptions.pubKeyCredParams - MDN, pubKeyCredParams - Web Authentication: An API for accessing Public Key Credentials Level 1

pubKeyCredParams

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder pubKeyCredParams(@Nonnull
                                                                                         PublicKeyCredentialParameters... pubKeyCredParams)

The pubKeyCredParams property of the PublicKeyCredentialCreationOptions dictionary is an Array whose elements are objects describing the desired features of the credential to be created. These objects define the type of public-key and the algorithm used for cryptographic signature operations.

See Also:

PublicKeyCredentialCreationOptions.pubKeyCredParams - MDN, pubKeyCredParams - Web Authentication: An API for accessing Public Key Credentials Level 1

rp

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder rp(@Nonnull
                                                                           PublicKeyCredentialRpEntity rp)

The rp property of the PublicKeyCredentialCreationOptions dictionary is an object describing the relying party which requested the credential creation (via navigator.credentials.create()).

See Also:

PublicKeyCredentialCreationOptions.rp - MDN, rp - Web Authentication: An API for accessing Public Key Credentials Level 1

timeout

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder timeout(int timeout)

The timeout property, of the PublicKeyCredentialCreationOptions dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the creation operation.

See Also:

PublicKeyCredentialCreationOptions.timeout - MDN, timeout - Web Authentication: An API for accessing Public Key Credentials Level 1

user

@JsOverlay
 @Nonnull
default PublicKeyCredentialCreationOptions.Builder user(@Nonnull
                                                                             PublicKeyCredentialUserEntity user)

The user property of the PublicKeyCredentialCreationOptions dictionary is an object describing the user account for which the credentials are generated (via navigator.credentials.create()).

See Also:

PublicKeyCredentialCreationOptions.user - MDN, user - Web Authentication: An API for accessing Public Key Credentials Level 1