akasha

Interface PublicKeyCredentialRequestOptions.Builder

All Superinterfaces:

PublicKeyCredentialRequestOptions

Enclosing interface:

PublicKeyCredentialRequestOptions

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public static interface PublicKeyCredentialRequestOptions.Builder
extends 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, (Web Authentication) # dictdef-publickeycredentialrequestoptions

Nested Class Summary

Nested classes/interfaces inherited from interface akasha.PublicKeyCredentialRequestOptions

PublicKeyCredentialRequestOptions.Builder

Method Summary

Modifier and Type	Method and Description
default PublicKeyCredentialRequestOptions.Builder	allowCredentials(JsArray<PublicKeyCredentialDescriptor> allowCredentials) allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval.
default PublicKeyCredentialRequestOptions.Builder	allowCredentials(PublicKeyCredentialDescriptor... allowCredentials) allowCredentials is an optional property of the PublicKeyCredentialRequestOptions dictionary which indicates the existing credentials acceptable for retrieval.
default PublicKeyCredentialRequestOptions.Builder	challenge(BufferSource challenge) The challenge property of the PublicKeyCredentialRequestOptions dictionary is a BufferSource used as a cryptographic challenge.
default PublicKeyCredentialRequestOptions.Builder	extensions(AuthenticationExtensionsClientInputs extensions) extensions, an optional property of the PublicKeyCredentialRequestOptions dictionary, is an object providing the client extensions and their input values.
default PublicKeyCredentialRequestOptions.Builder	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.
default PublicKeyCredentialRequestOptions.Builder	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.
default PublicKeyCredentialRequestOptions.Builder	userVerification(java.lang.String userVerification) userVerification is an optional property of the PublicKeyCredentialRequestOptions.

Methods inherited from interface akasha.PublicKeyCredentialRequestOptions

allowCredentials, challenge, challenge, extensions, rpId, setAllowCredentials, setAllowCredentials, setChallenge, setExtensions, setRpId, setTimeout, setUserVerification, timeout, userVerification

Method Detail

allowCredentials

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions.Builder 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

allowCredentials

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions.Builder 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

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions.Builder 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

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions.Builder 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

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions.Builder 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

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions.Builder 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

@JsOverlay
 @Nonnull
default PublicKeyCredentialRequestOptions.Builder userVerification(@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