U2fApiClient

AI-generated Key Takeaways

• This class is deprecated and users should use the Fido APIs instead.

• U2fApiClient is the entry point for interacting with regular app U2F APIs.

• U2F is a security key protocol within the FIDO industry standard for security keys.

• Public constructors are available for U2fApiClient using either an Activity or Context.

• Public methods include getRegisterIntent and getSignIntent for creating U2F registration and signing requests respectively.

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

This class is deprecated.
Please use Fido APIs instead.

The entry point for interacting with the regular app U2F APIs.

U2F (Universal Second Factor) is the name of the Security Key protocol in FIDO (Fast IDentity Online), which is the industry alliance where Security Keys are being standardized.

See Also

• //developers.google.com/identity/fido/android/native-apps

Public Constructor Summary

	U2fApiClient(Activity activity)
	U2fApiClient(Context context)

Public Method Summary

Task<U2fPendingIntent>	getRegisterIntent(RegisterRequestParams requestParams) Creates a Task with U2fPendingIntent.
Task<U2fPendingIntent>	getSignIntent(SignRequestParams requestParams) Creates a Task with U2fPendingIntent.

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 Constructors

public U2fApiClient (Activity activity)

Parameters

activity	Calling Activity

public U2fApiClient (Context context)

Parameters

context	The Context of the calling application

Public Methods

public Task<U2fPendingIntent> getRegisterIntent (RegisterRequestParams requestParams)

Creates a Task with U2fPendingIntent. When this Task object starts, it issues a U2F registration request, which is done once per U2F device per account for associating the new U2F device with that account. For example:

 Task result = mU2fApiClient.getRegisterIntent(registerRequestParams);
 ...
 result.addOnSuccessListener(
      new OnSuccessListener() {
        @Override
        public void onSuccess(U2fPendingIntent u2fPendingIntent) {
          if (u2fPendingIntent.hasPendingIntent()) {
            // Start a U2F registration request.
            u2fPendingIntent.launchPendingIntent(this, REGISTER_REQUEST_CODE);
          }
        }
      });
 result.addOnFailureListener(
     new OnFailureListener() {
       @Override
       public void onFailure(Exception e) {
         // Fail
       }
     }
 

Parameters

requestParams	for the registration request

Returns

• Task with PendingIntent to launch U2F registration request

public Task<U2fPendingIntent> getSignIntent (SignRequestParams requestParams)

Creates a Task with U2fPendingIntent. When this Task object starts, it issues a U2F signing request for a relying party to authenticate a user. For example:

 Task result = mU2fApiClient.getSignIntent(registerRequestParams);
 ...
 result.addOnSuccessListener(
      new OnSuccessListener() {
        @Override
        public void onSuccess(U2fPendingIntent u2fPendingIntent) {
          if (u2fPendingIntent.hasPendingIntent()) {
            // Start a U2F sign request.
            u2fPendingIntent.launchPendingIntent(this, SIGN_REQUEST_CODE);
          }
        }
      });
 result.addOnFailureListener(
     new OnFailureListener() {
       @Override
       public void onFailure(Exception e) {
         // Fail
       }
     }
 

Parameters

requestParams	for the sign request

Returns

• Task with PendingIntent to launch U2F signature request