akasha

Interface PublicKeyCredentialCreationOptions

All Known Subinterfaces:

PublicKeyCredentialCreationOptions.Builder

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="PublicKeyCredentialCreationOptions")
public interface 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

Modifier and Type	Interface and Description
static interface	PublicKeyCredentialCreationOptions.Builder The PublicKeyCredentialCreationOptions dictionary of the Web Authentication API holds options passed to navigators.credentials.create() in order to create a PublicKeyCredential.

Method Summary

Modifier and Type	Method and Description
java.lang.String	attestation() attestation is an optional property of the PublicKeyCredentialCreationOptions dictionary.
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.
BufferSource	challenge() The challenge property of the PublicKeyCredentialCreationOptions dictionary is a BufferSource used as a cryptographic challenge.
static PublicKeyCredentialCreationOptions.Builder	create(BufferSource challenge, JsArray<PublicKeyCredentialParameters> pubKeyCredParams, PublicKeyCredentialRpEntity rp, PublicKeyCredentialUserEntity user)
static PublicKeyCredentialCreationOptions.Builder	create(BufferSource challenge, PublicKeyCredentialParameters[] pubKeyCredParams, PublicKeyCredentialRpEntity rp, PublicKeyCredentialUserEntity user)
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.
AuthenticationExtensionsClientInputs	extensions() extensions, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an object providing the client extensions and their input values.
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.
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()).
void	setAttestation(java.lang.String attestation) attestation is an optional property of the PublicKeyCredentialCreationOptions dictionary.
void	setAuthenticatorSelection(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.
void	setChallenge(BufferSource challenge) The challenge property of the PublicKeyCredentialCreationOptions dictionary is a BufferSource used as a cryptographic challenge.
void	setExcludeCredentials(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 void	setExcludeCredentials(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.
void	setExtensions(AuthenticationExtensionsClientInputs extensions) extensions, an optional property of the PublicKeyCredentialCreationOptions dictionary, is an object providing the client extensions and their input values.
void	setPubKeyCredParams(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 void	setPubKeyCredParams(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.
void	setRp(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()).
void	setTimeout(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.
void	setUser(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()).
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.
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()).

Method Detail

create

@JsOverlay
 @Nonnull
static PublicKeyCredentialCreationOptions.Builder create(@Nonnull
                                                                              BufferSource challenge,
                                                                              @Nonnull
                                                                              JsArray<PublicKeyCredentialParameters> pubKeyCredParams,
                                                                              @Nonnull
                                                                              PublicKeyCredentialRpEntity rp,
                                                                              @Nonnull
                                                                              PublicKeyCredentialUserEntity user)

create

@JsOverlay
 @Nonnull
static PublicKeyCredentialCreationOptions.Builder create(@Nonnull
                                                                              BufferSource challenge,
                                                                              @Nonnull
                                                                              PublicKeyCredentialParameters[] pubKeyCredParams,
                                                                              @Nonnull
                                                                              PublicKeyCredentialRpEntity rp,
                                                                              @Nonnull
                                                                              PublicKeyCredentialUserEntity user)

attestation

@JsProperty(name="attestation")
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

setAttestation

@JsProperty
void setAttestation(@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

@JsProperty(name="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.

See Also:

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

setAuthenticatorSelection

@JsProperty
void setAuthenticatorSelection(@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

@JsProperty(name="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

setChallenge

@JsProperty
void setChallenge(@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

@JsProperty(name="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. 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

setExcludeCredentials

@JsProperty
void setExcludeCredentials(@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

setExcludeCredentials

@JsOverlay
default void setExcludeCredentials(@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

@JsProperty(name="extensions")
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

setExtensions

@JsProperty
void setExtensions(@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

@JsProperty(name="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

setPubKeyCredParams

@JsProperty
void setPubKeyCredParams(@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

setPubKeyCredParams

@JsOverlay
default void setPubKeyCredParams(@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

@JsProperty(name="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

setRp

@JsProperty
void setRp(@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

@JsProperty(name="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

setTimeout

@JsProperty
void setTimeout(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

@JsProperty(name="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

setUser

@JsProperty
void setUser(@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