PublicKeyCredentialRequestOptions.Builder | Doclava
public static final class

PublicKeyCredentialRequestOptions.Builder

extends Object
java.lang.Object
   ↳ com.google.android.gms.fido.fido2.api.common.PublicKeyCredentialRequestOptions.Builder

Class Overview

Builds PublicKeyCredentialRequestOptions.

Summary

Public Constructors
PublicKeyCredentialRequestOptions.Builder()
Creates an empty builder.
Public Methods
PublicKeyCredentialRequestOptions build()
PublicKeyCredentialRequestOptions.Builder setAllowList(List<PublicKeyCredentialDescriptor> allowList)
Sets list of public key credential accepted to the caller.
PublicKeyCredentialRequestOptions.Builder setChallenge(byte[] challenge)
Sets challenge.
PublicKeyCredentialRequestOptions.Builder setRequestId(Integer requestId)
Sets the request id in order to link together events into a single session (the span of events between the time that the server initiates a single FIDO2 request to the client and receives reply) on a single device.
PublicKeyCredentialRequestOptions.Builder setRpId(String rpId)
Sets identifier for a relying party, on whose behalf a given authentication operation is being performed.
PublicKeyCredentialRequestOptions.Builder setTimeoutSeconds(Double timeoutSeconds)
Sets timeout in seconds.
PublicKeyCredentialRequestOptions.Builder setTokenBindingIdValue(TokenBindingIdValue tokenBindingIdValue)
Sets token binding id value associated with the calling origin.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PublicKeyCredentialRequestOptions.Builder ()

Creates an empty builder.

Public Methods

public PublicKeyCredentialRequestOptions.Builder setAllowList (List<PublicKeyCredentialDescriptor> allowList)

Sets list of public key credential accepted to the caller. This field is optional.

Parameters
allowList List
Returns
PublicKeyCredentialRequestOptions.Builder

public PublicKeyCredentialRequestOptions.Builder setChallenge (byte[] challenge)

Sets challenge.

Parameters
challenge byte
Returns
PublicKeyCredentialRequestOptions.Builder

public PublicKeyCredentialRequestOptions.Builder setRequestId (Integer requestId)

Sets the request id in order to link together events into a single session (the span of events between the time that the server initiates a single FIDO2 request to the client and receives reply) on a single device. This field is optional.

Parameters
requestId Integer
Returns
PublicKeyCredentialRequestOptions.Builder

public PublicKeyCredentialRequestOptions.Builder setRpId (String rpId)

Sets identifier for a relying party, on whose behalf a given authentication operation is being performed. A public key credential can only be used for authentication with the same replying party it was registered with.

Note: the RpId should be an effective domain (aka, without scheme or port); and it should also be in secure context (aka https connection). Apps-facing API needs to check the package signature against Digital Asset Links, whose resource is the RP ID with prepended "https://". Privileged (browser) API doesn't need the check.

Parameters
rpId String
Returns
PublicKeyCredentialRequestOptions.Builder

public PublicKeyCredentialRequestOptions.Builder setTimeoutSeconds (Double timeoutSeconds)

Sets timeout in seconds. This field is optional.

Parameters
timeoutSeconds Double
Returns
PublicKeyCredentialRequestOptions.Builder

public PublicKeyCredentialRequestOptions.Builder setTokenBindingIdValue (TokenBindingIdValue tokenBindingIdValue)

Sets token binding id value associated with the calling origin. This field is optional.

Parameters
tokenBindingIdValue TokenBindingIdValue
Returns
PublicKeyCredentialRequestOptions.Builder