# androidx.credentials

*** ** * ** ***

## Interfaces

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManager` | Manages user authentication flows. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialManagerCallback` | Callback interface intended for use when an asynchronous Credential Manager operation may result in a failure. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialProvider` | Provider interface to be implemented by system credential providers that will fulfill Credential Manager requests. |

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/ClearCredentialStateRequest` | Request class for clearing a user's credential state from the credential providers. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateCredentialRequest` | Base request class for registering a credential. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateCredentialRequest.DisplayInfo` | Information that may be used for display purposes when rendering UIs to collect the user consent and choice. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateCredentialResponse` | Base response class for the credential creation operation made with the `https://developer.android.com/reference/kotlin/androidx/credentials/CreateCredentialRequest`. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateCustomCredentialRequest` | Base custom create request class for registering a credential. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateCustomCredentialResponse` | Base custom create response class for the credential creation operation made with the `https://developer.android.com/reference/kotlin/androidx/credentials/CreateCustomCredentialRequest`. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateDigitalCredentialRequest` | A request to save a digital credential to a holder application of the user's choice. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateDigitalCredentialResponse` | A response of creating a digital credential. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreatePasswordRequest` | A request to save the user password credential with their password provider. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreatePasswordResponse` | A response of a password saving flow. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreatePublicKeyCredentialRequest` | A request to register a passkey from the user's public key credential provider. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreatePublicKeyCredentialResponse` | A response of a public key credential (passkey) flow. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateRestoreCredentialRequest` | A request to create a restore credential used for app restore purpose. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CreateRestoreCredentialResponse` | A response of the `https://developer.android.com/reference/kotlin/androidx/credentials/RestoreCredential` flow. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/Credential` | Base class for a credential with which the user consented to authenticate to the app. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CredentialOption` | Base class for getting a specific type of credentials. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/CustomCredential` | Base class for a custom credential with which the user consented to authenticate to the app. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/DigitalCredential` | Represents the user's digital credential, generally used for verification or sign-in purposes. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetCredentialRequest` | Encapsulates a request to get a user credential. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetCredentialRequest.Builder` | A builder for `https://developer.android.com/reference/kotlin/androidx/credentials/GetCredentialRequest`. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetCredentialResponse` | Encapsulates the result of a user credential request. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetCustomCredentialOption` | Allows extending custom versions of GetCredentialOptions for unique use cases. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetDigitalCredentialOption` | A request to retrieve the user's digital credential, normally used for verification or sign-in purpose. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetPasswordOption` | A request to retrieve the user's saved application password from their password provider. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetPublicKeyCredentialOption` | A request to get passkeys from the user's public key credential provider. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/GetRestoreCredentialOption` | A request to get the restore credential from the restore credential provider. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/PasswordCredential` | Represents the user's password credential granted by the user for app sign-in. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/PendingGetCredentialRequest` | Request to be set on an Android `https://developer.android.com/reference/android/view/View.html`, which will be invoked when the `https://developer.android.com/reference/android/view/View.html` is focused/clicked by the user. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/PrepareGetCredentialResponse` | A response object that indicates the get-credential prefetch work is complete and provides metadata about it. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/PrepareGetCredentialResponse.PendingGetCredentialHandle` | A handle that represents a pending get-credential operation. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/PrepareGetCredentialResponse.TestBuilder` | A builder for `https://developer.android.com/reference/android/credentials/PrepareGetCredentialResponse.html` for test use only. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/PublicKeyCredential` | Represents the user's passkey credential granted by the user for app sign-in. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/RestoreCredential` | Represents the user's restore credential for the app sign in. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/SignalAllAcceptedCredentialIdsRequest` | A request to signal the complete list of public key credentials ids for a given user. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/SignalCredentialStateRequest` | Base request class for sending credential state signals to providers. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/SignalCredentialStateResponse` | Received by calling apps on successful propagation of a signal credential state request to the user's credential providers. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/SignalCurrentUserDetailsRequest` | A request to signal the user's current name and display name. |
| `https://developer.android.com/reference/kotlin/androidx/credentials/SignalUnknownCredentialRequest` | A request to signal that a credential ID was not recognized by the relying party. |

## Annotations

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/ExperimentalDigitalCredentialApi` |   |

## Type aliases

|---|---|
| `HasAuthenticationResultsDelegate` |   |
| `HasCredentialResultsDelegate` |   |
| `HasRemoteResultsDelegate` |   |

## Extension properties summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/credentials/PendingGetCredentialRequest?` | `https://developer.android.com/reference/android/view/View.html.https://developer.android.com/reference/kotlin/androidx/credentials/package-summary#(android.view.View).pendingGetCredentialRequest()` |

## Extension properties

### View.pendingGetCredentialRequest

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/CredentialManagerViewHandler.kt+symbol:pendingGetCredentialRequest) Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
var View.pendingGetCredentialRequest: PendingGetCredentialRequest?
```