# android.credentials

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

# android.credentials

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/credentials/package-summary "View this page in Kotlin")\|Java

## Classes

|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ClearCredentialStateRequest](https://developer.android.com/reference/android/credentials/ClearCredentialStateRequest)                                                         | A request class for clearing a user's credential state from the credential providers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| [CreateCredentialRequest](https://developer.android.com/reference/android/credentials/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](https://developer.android.com/reference/android/credentials/CreateCredentialRequest.Builder)                                                 | A builder for[CreateCredentialRequest](https://developer.android.com/reference/android/credentials/CreateCredentialRequest).                                                                                                                                                                                                                                                                                                                                                                                                                              |
| [CreateCredentialResponse](https://developer.android.com/reference/android/credentials/CreateCredentialResponse)                                                               | A response object that encapsulates the result of a successful credential creation execution.                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| [Credential](https://developer.android.com/reference/android/credentials/Credential)                                                                                           | Represents a user credential that can be used to authenticate to your app.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| [CredentialDescription](https://developer.android.com/reference/android/credentials/CredentialDescription)                                                                     | Represents the type and contained data fields of a[Credential](https://developer.android.com/reference/android/credentials/Credential).                                                                                                                                                                                                                                                                                                                                                                                                                   |
| [CredentialManager](https://developer.android.com/reference/android/credentials/CredentialManager)                                                                             | Manages user authentication flows.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| [CredentialOption](https://developer.android.com/reference/android/credentials/CredentialOption)                                                                               | Information about a specific type of credential to be requested during a[CredentialManager.getCredential(Context, GetCredentialRequest, CancellationSignal, Executor, OutcomeReceiver)](https://developer.android.com/reference/android/credentials/CredentialManager#getCredential(android.content.Context,%20android.credentials.GetCredentialRequest,%20android.os.CancellationSignal,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<android.credentials.GetCredentialResponse,android.credentials.GetCredentialException>))operation. |
| [CredentialOption.Builder](https://developer.android.com/reference/android/credentials/CredentialOption.Builder)                                                               | A builder for[CredentialOption](https://developer.android.com/reference/android/credentials/CredentialOption).                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| [GetCredentialRequest](https://developer.android.com/reference/android/credentials/GetCredentialRequest)                                                                       | A request to retrieve the user credential, potentially launching UI flows to let the user pick from different credential sources.                                                                                                                                                                                                                                                                                                                                                                                                                         |
| [GetCredentialRequest.Builder](https://developer.android.com/reference/android/credentials/GetCredentialRequest.Builder)                                                       | A builder for[GetCredentialRequest](https://developer.android.com/reference/android/credentials/GetCredentialRequest).                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| [GetCredentialResponse](https://developer.android.com/reference/android/credentials/GetCredentialResponse)                                                                     | A response object that encapsulates the credential successfully retrieved from the user.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [PrepareGetCredentialResponse](https://developer.android.com/reference/android/credentials/PrepareGetCredentialResponse)                                                       | A response object that prefetches user app credentials and provides metadata about them.                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [PrepareGetCredentialResponse.PendingGetCredentialHandle](https://developer.android.com/reference/android/credentials/PrepareGetCredentialResponse.PendingGetCredentialHandle) | A handle that represents a pending get-credential operation.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| [RegisterCredentialDescriptionRequest](https://developer.android.com/reference/android/credentials/RegisterCredentialDescriptionRequest)                                       | A request to register a[ComponentName](https://developer.android.com/reference/android/content/ComponentName)that contains an actively provisioned[Credential](https://developer.android.com/reference/android/credentials/Credential)represented by a[CredentialDescription](https://developer.android.com/reference/android/credentials/CredentialDescription).                                                                                                                                                                                         |
| [UnregisterCredentialDescriptionRequest](https://developer.android.com/reference/android/credentials/UnregisterCredentialDescriptionRequest)                                   | A request to unregister a[ComponentName](https://developer.android.com/reference/android/content/ComponentName)that contains an actively provisioned[Credential](https://developer.android.com/reference/android/credentials/Credential)represented by a[CredentialDescription](https://developer.android.com/reference/android/credentials/CredentialDescription).                                                                                                                                                                                       |

## Exceptions

|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ClearCredentialStateException](https://developer.android.com/reference/android/credentials/ClearCredentialStateException) | Represents an error encountered during the[CredentialManager.clearCredentialState(ClearCredentialStateRequest, CancellationSignal, Executor, OutcomeReceiver)](https://developer.android.com/reference/android/credentials/CredentialManager#clearCredentialState(android.credentials.ClearCredentialStateRequest,%20android.os.CancellationSignal,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<java.lang.Void,android.credentials.ClearCredentialStateException>))operation.                                               |
| [CreateCredentialException](https://developer.android.com/reference/android/credentials/CreateCredentialException)         | Represents an error encountered during the[CredentialManager.createCredential(Context, CreateCredentialRequest, CancellationSignal, Executor, OutcomeReceiver)](https://developer.android.com/reference/android/credentials/CredentialManager#createCredential(android.content.Context,%20android.credentials.CreateCredentialRequest,%20android.os.CancellationSignal,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<android.credentials.CreateCredentialResponse,android.credentials.CreateCredentialException>))operation. |
| [GetCredentialException](https://developer.android.com/reference/android/credentials/GetCredentialException)               | Represents an error encountered during the[CredentialManager.getCredential(Context, GetCredentialRequest, CancellationSignal, Executor, OutcomeReceiver)](https://developer.android.com/reference/android/credentials/CredentialManager#getCredential(android.content.Context,%20android.credentials.GetCredentialRequest,%20android.os.CancellationSignal,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver<android.credentials.GetCredentialResponse,android.credentials.GetCredentialException>))operation.                   |

-

  ## Classes

  - [ClearCredentialStateRequest](https://developer.android.com/reference/android/credentials/ClearCredentialStateRequest)
  - [CreateCredentialRequest](https://developer.android.com/reference/android/credentials/CreateCredentialRequest)
  - [CreateCredentialRequest.Builder](https://developer.android.com/reference/android/credentials/CreateCredentialRequest.Builder)
  - [CreateCredentialResponse](https://developer.android.com/reference/android/credentials/CreateCredentialResponse)
  - [Credential](https://developer.android.com/reference/android/credentials/Credential)
  - [CredentialDescription](https://developer.android.com/reference/android/credentials/CredentialDescription)
  - [CredentialManager](https://developer.android.com/reference/android/credentials/CredentialManager)
  - [CredentialOption](https://developer.android.com/reference/android/credentials/CredentialOption)
  - [CredentialOption.Builder](https://developer.android.com/reference/android/credentials/CredentialOption.Builder)
  - [GetCredentialRequest](https://developer.android.com/reference/android/credentials/GetCredentialRequest)
  - [GetCredentialRequest.Builder](https://developer.android.com/reference/android/credentials/GetCredentialRequest.Builder)
  - [GetCredentialResponse](https://developer.android.com/reference/android/credentials/GetCredentialResponse)
  - [PrepareGetCredentialResponse](https://developer.android.com/reference/android/credentials/PrepareGetCredentialResponse)
  - [PrepareGetCredentialResponse.PendingGetCredentialHandle](https://developer.android.com/reference/android/credentials/PrepareGetCredentialResponse.PendingGetCredentialHandle)
  - [RegisterCredentialDescriptionRequest](https://developer.android.com/reference/android/credentials/RegisterCredentialDescriptionRequest)
  - [UnregisterCredentialDescriptionRequest](https://developer.android.com/reference/android/credentials/UnregisterCredentialDescriptionRequest)
-

  ## Exceptions

  - [ClearCredentialStateException](https://developer.android.com/reference/android/credentials/ClearCredentialStateException)
  - [CreateCredentialException](https://developer.android.com/reference/android/credentials/CreateCredentialException)
  - [GetCredentialException](https://developer.android.com/reference/android/credentials/GetCredentialException)