Fido2ApiClient

AI-generated Key Takeaways

• Fido2ApiClient is the entry point for interacting with FIDO2 APIs.

• The getRegisterPendingIntent method is used to initiate a FIDO2 registration request, associating a new FIDO2 device with an account.

• The getSignPendingIntent method is used to issue a FIDO2 signature request for user authentication by a relying party.

• The isUserVerifyingPlatformAuthenticatorAvailable method checks for the availability of a user-verifying platform authenticator on the device.

• The methods getRegisterIntent and getSignIntent are deprecated and replaced by their respective "PendingIntent" versions.

public class Fido2ApiClient extends GoogleApi<Api.ApiOptions.NoOptions>

The entry point for interacting with FIDO2 APIs.

Public Method Summary

Task<Fido2PendingIntent>	getRegisterIntent(PublicKeyCredentialCreationOptions requestOptions) This method is deprecated. use getRegisterPendingIntent(PublicKeyCredentialCreationOptions) instead
Task<PendingIntent>	getRegisterPendingIntent(PublicKeyCredentialCreationOptions requestOptions) Creates a Task with PendingIntent, when started, will issue a FIDO2 registration request, which is done once per FIDO2 device per account for associating the new FIDO2 device with that account.
Task<Fido2PendingIntent>	getSignIntent(PublicKeyCredentialRequestOptions requestOptions) This method is deprecated. use getSignPendingIntent(PublicKeyCredentialRequestOptions) instead
Task<PendingIntent>	getSignPendingIntent(PublicKeyCredentialRequestOptions requestOptions) Creates a Task with PendingIntent, when started, will issue a FIDO2 signature request for a relying party to authenticate a user.
Task<Boolean>	isUserVerifyingPlatformAuthenticatorAvailable() Creates a Task with Boolean, which check if a user verifying platform authenticator is available on the device.

Inherited Method Summary

From class com.google.android.gms.common.api.GoogleApi

String

getApiFallbackAttributionTag(Context arg0)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public Task<Fido2PendingIntent> getRegisterIntent (PublicKeyCredentialCreationOptions requestOptions)

This method is deprecated.
use getRegisterPendingIntent(PublicKeyCredentialCreationOptions) instead

public Task<PendingIntent> getRegisterPendingIntent (PublicKeyCredentialCreationOptions requestOptions)

Creates a Task with PendingIntent, when started, will issue a FIDO2 registration request, which is done once per FIDO2 device per account for associating the new FIDO2 device with that account. For example:

 Task result = fido2ApiClient.getRegisterPendingIntent(requestOptions);
 ...
 result.addOnSuccessListener(
      new OnSuccessListener() {
        @Override
        public void onSuccess(PendingIntent pendingIntent) {
          if (pendingIntent != null) {
            // Start a FIDO2 registration request.
            activity.startIntentSenderForResult(
              pendingIntent.getIntentSender(),
              REGISTER_REQUEST_CODE,
              null // fillInIntent,
              0 // flagsMask,
              0 // flagsValue,
              0 //extraFlags);
          }
        }
      });
 result.addOnFailureListener(
     new OnFailureListener() {
       @Override
       public void onFailure(Exception e) {
         // Fail
       }
     }
 

Parameters

requestOptions	for the registration request

Returns

• Task with PendingIntent to launch FIDO2 registration request

public Task<Fido2PendingIntent> getSignIntent (PublicKeyCredentialRequestOptions requestOptions)

This method is deprecated.
use getSignPendingIntent(PublicKeyCredentialRequestOptions) instead

public Task<PendingIntent> getSignPendingIntent (PublicKeyCredentialRequestOptions requestOptions)

Creates a Task with PendingIntent, when started, will issue a FIDO2 signature request for a relying party to authenticate a user. For example:

 Task result = fido2ApiClient.getSignPendingIntent(requestOptions);
 ...
 result.addOnSuccessListener(
      new OnSuccessListener() {
        @Override
        public void onSuccess(PendingIntent pendingIntent) {
          if (pendingIntent != null) {
            // Start a FIDO2 sign request.
            activity.startIntentSenderForResult(
               pendingIntent.getIntentSender(),
               SIGN_REQUEST_CODE,
               null, // fillInIntent
               0, // flagsMask
               0, // flagsValue
               0); //extraFlags
          }
        }
      });
 result.addOnFailureListener(
     new OnFailureListener() {
       @Override
       public void onFailure(Exception e) {
         // Fail
       }
     }
 

Parameters

requestOptions	for the sign request

Returns

• Task with PendingIntent to launch FIDO2 signature request

public Task<Boolean> isUserVerifyingPlatformAuthenticatorAvailable ()

Creates a Task with Boolean, which check if a user verifying platform authenticator is available on the device.