Fido2PrivilegedApiClient

AI-generated Key Takeaways

• Fido2PrivilegedApiClient is the main class for interacting with privileged FIDO2 APIs.

• You can retrieve a list of FIDO credentials for a given relying party ID using getCredentialList.

• getRegisterPendingIntent and getSignPendingIntent are used to initiate FIDO2 registration and signing requests, respectively, for privileged apps.

• You can check for the availability of a user verifying platform authenticator on the device using isUserVerifyingPlatformAuthenticatorAvailable.

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

The entry point for interacting with the privileged FIDO2 APIs.

Public Method Summary

Task<List<FidoCredentialDetails>>	getCredentialList(String rpId) Creates a Task with a list of FidoCredentialDetails which, when started, will retrieve a list of credentials associated with the given relying party ID.
Task<Fido2PendingIntent>	getRegisterIntent(BrowserPublicKeyCredentialCreationOptions requestOptions) This method is deprecated. use getRegisterPendingIntent(BrowserPublicKeyCredentialCreationOptions) instead
Task<PendingIntent>	getRegisterPendingIntent(BrowserPublicKeyCredentialCreationOptions requestOptions) Creates a Task with PendingIntent, when started, will issue a FIDO2 registration request for privileged apps.
Task<Fido2PendingIntent>	getSignIntent(BrowserPublicKeyCredentialRequestOptions requestOptions) This method is deprecated. use getSignPendingIntent(BrowserPublicKeyCredentialRequestOptions) instead
Task<PendingIntent>	getSignPendingIntent(BrowserPublicKeyCredentialRequestOptions requestOptions) Creates a Task with PendingIntent, when started, will issue a FIDO2 signature request for privileged apps.
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<List<FidoCredentialDetails>> getCredentialList (String rpId)

Creates a Task with a list of FidoCredentialDetails which, when started, will retrieve a list of credentials associated with the given relying party ID.

Parameters

rpId	indicating the relying party for which we want to list credentials

Returns

• PendingResult with PendingIntent to retrieve the credential list

public Task<Fido2PendingIntent> getRegisterIntent (BrowserPublicKeyCredentialCreationOptions requestOptions)

This method is deprecated.
use getRegisterPendingIntent(BrowserPublicKeyCredentialCreationOptions) instead

Creates a Task with PendingIntent, when started, will issue a FIDO2 registration request for privileged apps.

Parameters

requestOptions	for the registration request from a Web browser

Returns

• PendingResult with PendingIntent to launch FIDO2 registration request

public Task<PendingIntent> getRegisterPendingIntent (BrowserPublicKeyCredentialCreationOptions requestOptions)

Creates a Task with PendingIntent, when started, will issue a FIDO2 registration request for privileged apps.

Parameters

requestOptions	for the registration request from a Web browser

Returns

• PendingResult with PendingIntent to launch FIDO2 registration request

public Task<Fido2PendingIntent> getSignIntent (BrowserPublicKeyCredentialRequestOptions requestOptions)

This method is deprecated.
use getSignPendingIntent(BrowserPublicKeyCredentialRequestOptions) instead

Creates a Task with PendingIntent, when started, will issue a FIDO2 signature request for privileged apps.

Parameters

requestOptions	for the sign request from a Web browser

Returns

• PendingResult with PendingIntent to launch FIDO2 signature request

public Task<PendingIntent> getSignPendingIntent (BrowserPublicKeyCredentialRequestOptions requestOptions)

Creates a Task with PendingIntent, when started, will issue a FIDO2 signature request for privileged apps.

Parameters

requestOptions	for the sign request from a Web browser

Returns

• PendingResult 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.