akasha

Interface PublicKeyCredentialRequestOptions

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public interface PublicKeyCredentialRequestOptions

The PublicKeyCredentialRequestOptions dictionary of the Web Authentication API holds the options passed to navigator.credentials.get() in order to fetch a given PublicKeyCredential.

See Also:

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

Method Summary

Modifier and Type	Method and Description
JsArray<PublicKeyCredentialDescriptor>	allowCredentials() allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval.
default PublicKeyCredentialRequestOptions	allowCredentials(JsArray<PublicKeyCredentialDescriptor> allowCredentials) allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval.
default PublicKeyCredentialRequestOptions	allowCredentials(PublicKeyCredentialDescriptor... allowCredentials) allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval.
BufferSource	challenge() The challenge property of the PublicKeyCredentialRequestOptions dictionary is a BufferSource used as a cryptographic challenge.
default PublicKeyCredentialRequestOptions	challenge(BufferSource challenge) The challenge property of the PublicKeyCredentialRequestOptions dictionary is a BufferSource used as a cryptographic challenge.
static PublicKeyCredentialRequestOptions	create(BufferSource challenge)
AuthenticationExtensionsClientInputs	extensions() extensions, an optional property of the PublicKeyCredentialRequestOptions dictionary, is an object providing the client extensions and their input values.
default PublicKeyCredentialRequestOptions	extensions(AuthenticationExtensionsClientInputs extensions) extensions, an optional property of the PublicKeyCredentialRequestOptions dictionary, is an object providing the client extensions and their input values.
java.lang.String	rpId() The rpId property, of the PublicKeyCredentialRequestOptions dictionary, is an optional property which indicates the relying party's identifier as a USVString.
default PublicKeyCredentialRequestOptions	rpId(java.lang.String rpId) The rpId property, of the PublicKeyCredentialRequestOptions dictionary, is an optional property which indicates the relying party's identifier as a USVString.
void	setAllowCredentials(JsArray<PublicKeyCredentialDescriptor> allowCredentials) allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval.
default void	setAllowCredentials(PublicKeyCredentialDescriptor... allowCredentials) allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval.
void	setChallenge(BufferSource challenge) The challenge property of the PublicKeyCredentialRequestOptions dictionary is a BufferSource used as a cryptographic challenge.
void	setExtensions(AuthenticationExtensionsClientInputs extensions) extensions, an optional property of the PublicKeyCredentialRequestOptions dictionary, is an object providing the client extensions and their input values.
void	setRpId(java.lang.String rpId) The rpId property, of the PublicKeyCredentialRequestOptions dictionary, is an optional property which indicates the relying party's identifier as a USVString.
void	setTimeout(int timeout) The timeout property, of the PublicKeyCredentialRequestOptions dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the retrieval operation.
void	setUserVerification(java.lang.String userVerification) userVerification is an optional property of the PublicKeyCredentialRequestOptions.
int	timeout() The timeout property, of the PublicKeyCredentialRequestOptions dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the retrieval operation.
default PublicKeyCredentialRequestOptions	timeout(int timeout) The timeout property, of the PublicKeyCredentialRequestOptions dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the retrieval operation.
java.lang.String	userVerification() userVerification is an optional property of the PublicKeyCredentialRequestOptions.
default PublicKeyCredentialRequestOptions	userVerification(java.lang.String userVerification) userVerification is an optional property of the PublicKeyCredentialRequestOptions.

Method Detail

create

@JsOverlay
 @Nonnull
static PublicKeyCredentialRequestOptions create(@Nonnull
                                                                     BufferSource challenge)

allowCredentials

@JsProperty(name="allowCredentials")
JsArray<PublicKeyCredentialDescriptor> allowCredentials()

allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval. This is an Array of credential descriptors.

See Also:

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

setAllowCredentials

@JsProperty
void setAllowCredentials(@Nonnull
                                     JsArray<PublicKeyCredentialDescriptor> allowCredentials)

allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval. This is an Array of credential descriptors.

See Also:

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

allowCredentials

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions allowCredentials(@Nonnull
                                                                                JsArray<PublicKeyCredentialDescriptor> allowCredentials)

allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval. This is an Array of credential descriptors.

See Also:

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

setAllowCredentials

@JsOverlay
default void setAllowCredentials(@Nonnull
                                            PublicKeyCredentialDescriptor... allowCredentials)

allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval. This is an Array of credential descriptors.

See Also:

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

allowCredentials

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions allowCredentials(@Nonnull
                                                                                PublicKeyCredentialDescriptor... allowCredentials)

allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval. This is an Array of credential descriptors.

See Also:

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

challenge

@JsProperty(name="challenge")
 @Nonnull
BufferSource challenge()

The challenge property of the PublicKeyCredentialRequestOptions 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's private key and produce AuthenticatorAssertionResponse.signature which should be sent back to the server as part of the response.

See Also:

PublicKeyCredentialRequestOptions.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 PublicKeyCredentialRequestOptions 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's private key and produce AuthenticatorAssertionResponse.signature which should be sent back to the server as part of the response.

See Also:

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

challenge

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions challenge(@Nonnull
                                                                         BufferSource challenge)

The challenge property of the PublicKeyCredentialRequestOptions 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's private key and produce AuthenticatorAssertionResponse.signature which should be sent back to the server as part of the response.

See Also:

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

extensions

@JsProperty(name="extensions")
AuthenticationExtensionsClientInputs extensions()

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

See Also:

PublicKeyCredentialRequestOptions.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 PublicKeyCredentialRequestOptions dictionary, is an object providing the client extensions and their input values.

See Also:

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

extensions

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions extensions(@Nonnull
                                                                          AuthenticationExtensionsClientInputs extensions)

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

See Also:

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

rpId

@JsProperty(name="rpId")
java.lang.String rpId()

The rpId property, of the PublicKeyCredentialRequestOptions dictionary, is an optional property which indicates the relying party's identifier as a USVString. Its value can only be a suffix of the current origin's domain. For example, if you are browsing on foo.example.com, the rpId value may be "example.com" but not "bar.org" or "baz.example.com".

See Also:

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

setRpId

@JsProperty
void setRpId(@Nonnull
                         java.lang.String rpId)

The rpId property, of the PublicKeyCredentialRequestOptions dictionary, is an optional property which indicates the relying party's identifier as a USVString. Its value can only be a suffix of the current origin's domain. For example, if you are browsing on foo.example.com, the rpId value may be "example.com" but not "bar.org" or "baz.example.com".

See Also:

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

rpId

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions rpId(@Nonnull
                                                                    java.lang.String rpId)

The rpId property, of the PublicKeyCredentialRequestOptions dictionary, is an optional property which indicates the relying party's identifier as a USVString. Its value can only be a suffix of the current origin's domain. For example, if you are browsing on foo.example.com, the rpId value may be "example.com" but not "bar.org" or "baz.example.com".

See Also:

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

timeout

@JsProperty(name="timeout")
int timeout()

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

See Also:

PublicKeyCredentialRequestOptions.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 PublicKeyCredentialRequestOptions dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the retrieval operation.

See Also:

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

timeout

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions timeout(int timeout)

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

See Also:

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

userVerification

@JsProperty(name="userVerification")
 @UserVerificationRequirement
java.lang.String userVerification()

userVerification is an optional property of the PublicKeyCredentialRequestOptions. This is a string which indicates how the user verification should be part of the authentication process.

See Also:

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

setUserVerification

@JsProperty
void setUserVerification(@UserVerificationRequirement @Nonnull
                                     java.lang.String userVerification)

userVerification is an optional property of the PublicKeyCredentialRequestOptions. This is a string which indicates how the user verification should be part of the authentication process.

See Also:

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

userVerification

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions userVerification(@UserVerificationRequirement @Nonnull
                                                                                java.lang.String userVerification)

userVerification is an optional property of the PublicKeyCredentialRequestOptions. This is a string which indicates how the user verification should be part of the authentication process.

See Also:

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