androidx.credentials.provider

Classes

Action

An actionable entry that is returned as part of the android.service.credentials.BeginGetCredentialResponse, and then shown on the user selector under a separate category of 'Actions'.
Action.Builder

A builder for Action
AuthenticationAction

An entry on the selector, denoting that the provider service is locked and authentication is needed to proceed.
AuthenticationAction.Builder

A builder for AuthenticationAction
AuthenticationError

Error returned from the Biometric Prompt flow that is executed by androidx.credentials.CredentialManager after the user makes a selection on the Credential Manager account selector.
AuthenticationResult

Successful result returned from the Biometric Prompt authentication flow handled by androidx.credentials.CredentialManager.
BeginCreateCredentialRequest

Abstract request class for beginning a create credential request.
BeginCreateCredentialResponse

Response to BeginCreateCredentialRequest.
BeginCreateCredentialResponse.Builder

Builder for BeginCreateCredentialResponse.
BeginCreateCustomCredentialRequest

Base custom begin create request class for registering a credential.
BeginCreatePasswordCredentialRequest

Request to begin saving a password credential, received by the provider with a CredentialProviderBaseService.onBeginCreateCredentialRequest call.
BeginCreatePublicKeyCredentialRequest

Request to begin registering a public key credential.
BeginGetCredentialOption

Base class that a credential provider receives during the query phase of a get-credential flow.
BeginGetCredentialRequest

Query stage request for getting user's credentials from a given credential provider.
BeginGetCredentialResponse

Response from a credential provider to BeginGetCredentialRequest, containing credential entries and other associated entries/data to be shown on the account selector UI.
BeginGetCredentialResponse.Builder

Builder for BeginGetCredentialResponse.
BeginGetCustomCredentialOption

Allows extending custom versions of BeginGetCredentialOptions for unique use cases.
BeginGetPasswordOption

A request to a password provider to begin the flow of retrieving the user's saved passwords.
BeginGetPublicKeyCredentialOption

A request to begin the flow of getting passkeys from the user's public key credential provider.
BiometricPromptData

Biometric prompt data that can be optionally used to provide information needed for the system to show a biometric prompt directly embedded into the Credential Manager selector.
BiometricPromptData.Builder

Builder for constructing an instance of BiometricPromptData
BiometricPromptResult

The result of a Biometric Prompt authentication flow, that is propagated to the provider if the provider requested for androidx.credentials.CredentialManager to handle the authentication flow.
CallingAppInfo

Information pertaining to the calling application.
CreateEntry

An entry to be shown on the selector during a create flow initiated when an app calls CredentialManager.createCredential
CreateEntry.Builder

A builder for CreateEntry
CredentialEntry

Base class for a credential entry to be displayed on the selector.
CredentialProviderService

A CredentialProviderService is a service used to save and retrieve credentials for a given user, upon the request of a client app that typically uses these credentials for sign-in flows.
CustomCredentialEntry

Custom credential entry for a custom credential type that is displayed on the account selector UI.
CustomCredentialEntry.Builder

Builder for CustomCredentialEntry
PasswordCredentialEntry

A password credential entry that is displayed on the account selector UI.
PasswordCredentialEntry.Builder

Builder for PasswordCredentialEntry
PendingIntentHandler

PendingIntentHandler to be used by credential providers to extract requests from a given intent, or to set back a response or an exception to a given intent while dealing with activities invoked by pending intents set on a CreateEntry for the create flow, or on a CredentialEntry, AuthenticationAction, Action, or a RemoteEntry set for a get flow.
ProviderClearCredentialStateRequest

Request class for clearing a user's credential state from the credential providers.
ProviderCreateCredentialRequest

Final request received by the provider after the user has selected a given CreateEntry on the UI.
ProviderGetCredentialRequest

Request received by the provider after the query phase of the get flow is complete i.e. the user was presented with a list of credentials, and the user has now made a selection from the list of CredentialEntry presented on the selector UI.
PublicKeyCredentialEntry

A public key credential entry that is displayed on the account selector UI.
PublicKeyCredentialEntry.Builder

Builder for PublicKeyCredentialEntry
RemoteEntry

An entry on the selector, denoting that the credential request will be completed on a remote device.
RemoteEntry.Builder

A builder for RemoteEntry
SigningInfoCompat

Signing information for an app package.

Extension functions summary

BeginGetCredentialResponse?

Returns the begin get response from the intent.
CreateCredentialResponse?

Returns the create response from the intent.
CreateCredentialException?

Returns the stored create credential exception from the intent.
GetCredentialException?

Returns the stored get credential exception from the intent.
GetCredentialResponse?

Returns the get response from the intent.

Extension functions

getBeginGetResponse

@RequiresApi(value = 34)
fun Intent.getBeginGetResponse(): BeginGetCredentialResponse?

Returns the begin get response from the intent.

getCreateCredentialCredentialResponse

@RequiresApi(value = 34)
fun Intent.getCreateCredentialCredentialResponse(): CreateCredentialResponse?

Returns the create response from the intent.

getCreateCredentialException

@RequiresApi(value = 34)
fun Intent.getCreateCredentialException(): CreateCredentialException?

Returns the stored create credential exception from the intent.

getGetCredentialException

@RequiresApi(value = 34)
fun Intent.getGetCredentialException(): GetCredentialException?

Returns the stored get credential exception from the intent.

getGetCredentialResponse

@RequiresApi(value = 34)
fun Intent.getGetCredentialResponse(): GetCredentialResponse?

Returns the get response from the intent.