Stay organized with collections
Save and categorize content based on your preferences.
android.credentials
Classes
Exceptions
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# android.credentials\n===================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/credentials/package-summary \"View this page in Java\")\n\nClasses\n-------\n\n|------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [ClearCredentialStateRequest](/reference/kotlin/android/credentials/ClearCredentialStateRequest) | A request class for clearing a user's credential state from the credential providers. |\n| [CreateCredentialRequest](/reference/kotlin/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. |\n| [CreateCredentialResponse](/reference/kotlin/android/credentials/CreateCredentialResponse) | A response object that encapsulates the result of a successful credential creation execution. |\n| [Credential](/reference/kotlin/android/credentials/Credential) | Represents a user credential that can be used to authenticate to your app. |\n| [CredentialDescription](/reference/kotlin/android/credentials/CredentialDescription) | Represents the type and contained data fields of a [Credential](/reference/kotlin/android/credentials/Credential). |\n| [CredentialManager](/reference/kotlin/android/credentials/CredentialManager) | Manages user authentication flows. |\n| [CredentialOption](/reference/kotlin/android/credentials/CredentialOption) | Information about a specific type of credential to be requested during a android. |\n| [GetCredentialRequest](/reference/kotlin/android/credentials/GetCredentialRequest) | A request to retrieve the user credential, potentially launching UI flows to let the user pick from different credential sources. |\n| [GetCredentialResponse](/reference/kotlin/android/credentials/GetCredentialResponse) | A response object that encapsulates the credential successfully retrieved from the user. |\n| [PrepareGetCredentialResponse](/reference/kotlin/android/credentials/PrepareGetCredentialResponse) | A response object that prefetches user app credentials and provides metadata about them. |\n| [RegisterCredentialDescriptionRequest](/reference/kotlin/android/credentials/RegisterCredentialDescriptionRequest) | A request to register a [ComponentName](../content/ComponentName.html#) that contains an actively provisioned [Credential](/reference/kotlin/android/credentials/Credential) represented by a [CredentialDescription](/reference/kotlin/android/credentials/CredentialDescription). |\n| [UnregisterCredentialDescriptionRequest](/reference/kotlin/android/credentials/UnregisterCredentialDescriptionRequest) | A request to unregister a [ComponentName](../content/ComponentName.html#) that contains an actively provisioned [Credential](/reference/kotlin/android/credentials/Credential) represented by a [CredentialDescription](/reference/kotlin/android/credentials/CredentialDescription). |\n\nExceptions\n----------\n\n|------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [ClearCredentialStateException](/reference/kotlin/android/credentials/ClearCredentialStateException) | Represents an error encountered during the [CredentialManager.clearCredentialState(ClearCredentialStateRequest,](/reference/kotlin/android/credentials/CredentialManager#clearCredentialState(android.credentials.ClearCredentialStateRequest,%20android.os.CancellationSignal,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver)) operation. |\n| [CreateCredentialException](/reference/kotlin/android/credentials/CreateCredentialException) | Represents an error encountered during the [CredentialManager.createCredential(Context, CreateCredentialRequest,](/reference/kotlin/android/credentials/CredentialManager#createCredential(android.content.Context,%20android.credentials.CreateCredentialRequest,%20android.os.CancellationSignal,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver)) operation. |\n| [GetCredentialException](/reference/kotlin/android/credentials/GetCredentialException) | Represents an error encountered during the [CredentialManager.getCredential(Context, GetCredentialRequest,](/reference/kotlin/android/credentials/CredentialManager#getCredential(android.content.Context,%20android.credentials.GetCredentialRequest,%20android.os.CancellationSignal,%20java.util.concurrent.Executor,%20android.os.OutcomeReceiver)) operation. |"]]
