Android.Credentials Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides Android framework APIs to create and retrieve credentials, clear credential state, and register credential descriptions.

Classes

Name	Description
ClearCredentialStateException	Represents an error encountered during the `CredentialManager#clearCredentialState(ClearCredentialStateRequest, CancellationSignal, Executor, OutcomeReceiver)` operation.
ClearCredentialStateRequest	A request class for clearing a user's credential state from the credential providers.
ClearCredentialStateRequest.InterfaceConsts	Contains the parcelable interface constants exposed for ClearCredentialStateRequest.
CreateCredentialException	Represents an error encountered during the `CredentialManager#createCredential(Context, CreateCredentialRequest, CancellationSignal, Executor, OutcomeReceiver)` operation.
CreateCredentialRequest	A request to register a specific type of user credential, potentially launching UI flows to collect user consent and any other operation needed.
CreateCredentialRequest.Builder	A builder for `CreateCredentialRequest`.
CreateCredentialRequest.InterfaceConsts	Contains the parcelable interface constants exposed for CreateCredentialRequest.
CreateCredentialResponse	A response object that encapsulates the result of a successful credential creation execution.
CreateCredentialResponse.InterfaceConsts	Contains the parcelable interface constants exposed for CreateCredentialResponse.
Credential	Represents a user credential that can be used to authenticate to your app.
Credential.InterfaceConsts	Contains the parcelable interface constants exposed for Credential.
CredentialDescription	Represents the type and contained data fields of a `Credential`.
CredentialDescription.InterfaceConsts	Contains the parcelable interface constants exposed for CredentialDescription.
CredentialManager	Manages user authentication flows.
CredentialOption	Information about a specific type of credential to be requested during a `CredentialManager#getCredential` operation.
CredentialOption.Builder	A builder for `CredentialOption`.
CredentialOption.InterfaceConsts	Contains the parcelable interface constants exposed for CredentialOption.
GetCredentialException	Represents an error encountered during the `CredentialManager#getCredential(Context, GetCredentialRequest, CancellationSignal, Executor, OutcomeReceiver)` operation.
GetCredentialRequest	A request to retrieve the user credential, potentially launching UI flows to let the user pick from different credential sources.
GetCredentialRequest.Builder	A builder for `GetCredentialRequest`.
GetCredentialRequest.InterfaceConsts	Contains the parcelable interface constants exposed for GetCredentialRequest.
GetCredentialResponse	A response object that encapsulates the credential successfully retrieved from the user.
GetCredentialResponse.InterfaceConsts	Contains the parcelable interface constants exposed for GetCredentialResponse.
PrepareGetCredentialResponse	A response object that prefetches user app credentials and provides metadata about them.
PrepareGetCredentialResponse.PendingGetCredentialHandle	A handle that represents a pending get-credential operation.
RegisterCredentialDescriptionRequest	A request to register a `ComponentName` that contains an actively provisioned `Credential` represented by a `CredentialDescription`.
RegisterCredentialDescriptionRequest.InterfaceConsts	Contains the parcelable interface constants exposed for RegisterCredentialDescriptionRequest.
UnregisterCredentialDescriptionRequest	A request to unregister a `ComponentName` that contains an actively provisioned `Credential` represented by a `CredentialDescription`.
UnregisterCredentialDescriptionRequest.InterfaceConsts	Contains the parcelable interface constants exposed for UnregisterCredentialDescriptionRequest.

Remarks

Use CredentialManager with the request and response types in this namespace. A retrieval request contains CredentialOption objects that specify the credential types and request data. Credential provider services use the types in Android.Service.Credentials.

These are bindings for the Android framework APIs, not the AndroidX credentials library. See the Android 16 credential manager source.