# androidx.credentials.provider

*** ** * ** ***

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/Action` | An actionable entry that is returned as part of the `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialResponse.html`, and then shown on the user selector under a separate category of 'Actions'. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/Action.Builder` | A builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/Action` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationAction` | An entry on the selector, denoting that the provider service is locked and authentication is needed to proceed. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationAction.Builder` | A builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationAction` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationError` | Error returned from the Biometric Prompt flow that is executed by `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManager` after the user makes a selection on the Credential Manager account selector. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationResult` | Successful result returned from the Biometric Prompt authentication flow handled by `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManager`. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreateCredentialRequest` | Abstract request class for beginning a create credential request. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreateCredentialResponse` | Response to `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreateCredentialRequest`. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreateCredentialResponse.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreateCredentialResponse`. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreateCustomCredentialRequest` | Base custom begin create request class for registering a credential. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreatePasswordCredentialRequest` | Request to begin saving a password credential, received by the provider with a CredentialProviderBaseService.onBeginCreateCredentialRequest call. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginCreatePublicKeyCredentialRequest` | Request to begin registering a public key credential. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialOption` | Base class that a credential provider receives during the query phase of a get-credential flow. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialRequest` | Query stage request for getting user's credentials from a given credential provider. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse` | Response from a credential provider to `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialRequest`, containing credential entries and other associated entries/data to be shown on the account selector UI. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse`. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCustomCredentialOption` | Allows extending custom versions of BeginGetCredentialOptions for unique use cases. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetPasswordOption` | A request to a password provider to begin the flow of retrieving the user's saved passwords. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetPublicKeyCredentialOption` | A request to begin the flow of getting passkeys from the user's public key credential provider. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/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. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptData.Builder` | Builder for constructing an instance of `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptData` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BiometricPromptResult` | The result of a Biometric Prompt authentication flow, that is propagated to the provider if the provider requested for `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManager` to handle the authentication flow. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CallingAppInfo` | Information pertaining to the calling application. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CreateEntry` | An entry to be shown on the selector during a create flow initiated when an app calls `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManager#createCredential(android.content.Context,androidx.credentials.CreateCredentialRequest)` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CreateEntry.Builder` | A builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CreateEntry` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CredentialEntry` | Base class for a credential entry to be displayed on the selector. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CredentialProviderService` | A `https://developer.android.com/reference/kotlin/androidx/credentials/provider/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. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CustomCredentialEntry` | Custom credential entry for a custom credential type that is displayed on the account selector UI. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CustomCredentialEntry.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CustomCredentialEntry` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/PasswordCredentialEntry` | A password credential entry that is displayed on the account selector UI. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/PasswordCredentialEntry.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/PasswordCredentialEntry` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/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 `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CreateEntry` for the create flow, or on a `https://developer.android.com/reference/android/service/credentials/CredentialEntry.html`, `https://developer.android.com/reference/kotlin/androidx/credentials/provider/AuthenticationAction`, `https://developer.android.com/reference/kotlin/androidx/credentials/provider/Action`, or a `https://developer.android.com/reference/kotlin/androidx/credentials/provider/RemoteEntry` set for a get flow. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/ProviderClearCredentialStateRequest` | Request class for clearing a user's credential state from the credential providers. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/ProviderCreateCredentialRequest` | Final request received by the provider after the user has selected a given `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CreateEntry` on the UI. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/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 `https://developer.android.com/reference/kotlin/androidx/credentials/provider/CredentialEntry` presented on the selector UI. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/PublicKeyCredentialEntry` | A public key credential entry that is displayed on the account selector UI. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/PublicKeyCredentialEntry.Builder` | Builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/PublicKeyCredentialEntry` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/RemoteEntry` | An entry on the selector, denoting that the credential request will be completed on a remote device. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/RemoteEntry.Builder` | A builder for `https://developer.android.com/reference/kotlin/androidx/credentials/provider/RemoteEntry` |
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/SigningInfoCompat` | Signing information for an app package. |

## Extension functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/provider/BeginGetCredentialResponse?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 34) https://developer.android.com/reference/android/content/Intent.html.https://developer.android.com/reference/kotlin/androidx/credentials/provider/package-summary#(android.content.Intent).getBeginGetResponse()()` Returns the begin get response from the intent. |
| `https://developer.android.com/reference/android/credentials/CreateCredentialResponse.html?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 34) https://developer.android.com/reference/android/content/Intent.html.https://developer.android.com/reference/kotlin/androidx/credentials/provider/package-summary#(android.content.Intent).getCreateCredentialCredentialResponse()()` Returns the create response from the intent. |
| `https://developer.android.com/reference/android/credentials/CreateCredentialException.html?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 34) https://developer.android.com/reference/android/content/Intent.html.https://developer.android.com/reference/kotlin/androidx/credentials/provider/package-summary#(android.content.Intent).getCreateCredentialException()()` Returns the stored create credential exception from the intent. |
| `https://developer.android.com/reference/android/credentials/GetCredentialException.html?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 34) https://developer.android.com/reference/android/content/Intent.html.https://developer.android.com/reference/kotlin/androidx/credentials/provider/package-summary#(android.content.Intent).getGetCredentialException()()` Returns the stored get credential exception from the intent. |
| `https://developer.android.com/reference/android/credentials/GetCredentialResponse.html?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi(value = 34) https://developer.android.com/reference/android/content/Intent.html.https://developer.android.com/reference/kotlin/androidx/credentials/provider/package-summary#(android.content.Intent).getGetCredentialResponse()()` Returns the get response from the intent. |

## Extension functions

### Intent.getBeginGetResponse

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/provider/IntentHandlerConverters.kt+function:getBeginGetResponse) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

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

Returns the begin get response from the intent.

### Intent.getCreateCredentialCredentialResponse

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/provider/IntentHandlerConverters.kt+function:getCreateCredentialCredentialResponse) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

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

Returns the create response from the intent.

### Intent.getCreateCredentialException

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/provider/IntentHandlerConverters.kt+function:getCreateCredentialException) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

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

Returns the stored create credential exception from the intent.

### Intent.getGetCredentialException

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/provider/IntentHandlerConverters.kt+function:getGetCredentialException) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

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

Returns the stored get credential exception from the intent.

### Intent.getGetCredentialResponse

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/provider/IntentHandlerConverters.kt+function:getGetCredentialResponse) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

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

Returns the get response from the intent.