Stay organized with collections Save and categorize content based on your preferences.

credentials

This library provides unified access to a user's credentials. This can include passwords, passkeys and federated credentials. This library should be used to provide seamless and secure sign-in experiences.
Latest Update Stable Release Release Candidate Beta Release Alpha Release
March 22, 2023 - - - 1.0.0-alpha05

Declaring dependencies

To add a dependency on credentials, you must add the Google Maven repository to your project. Read Google's Maven repository for more information.

Add the dependencies for the artifacts you need in the build.gradle file for your app or module:

Groovy

dependencies {
    implementation "androidx.credentials:credentials:1.0.0-alpha03"

    // optional - needed for credentials support from play services, for devices running
    // Android 13 and below.
    implementation "androidx.credentials:credentials-play-services-auth:1.0.0-alpha03"
}

Kotlin

dependencies {
    implementation("androidx.credentials:credentials:1.0.0-alpha03")

    // optional - needed for credentials support from play services, for devices running
    // Android 13 and below.
    implementation("androidx.credentials:credentials-play-services-auth:1.0.0-alpha03")
}

For more information about dependencies, see Add build dependencies.

Feedback

Your feedback helps make Jetpack better. Let us know if you discover new issues or have ideas for improving this library. Please take a look at the existing issues in this library before you create a new one. You can add your vote to an existing issue by clicking the star button.

Create a new issue

See the Issue Tracker documentation for more information.

There are no release notes for this artifact.

Version 1.2

Version 1.2.0-alpha02

March 8, 2023

androidx.credentials:credentials:1.2.0-alpha02 and androidx.credentials:credentials-play-services-auth:1.2.0-alpha02 are released. Developed from an internal branch.

API Changes

  • Enable testing of provider request classes by making constructors public.
  • Make icons required in all entry classes. However if credential providers do not provide icons, this library will have fallback icons.
  • Allow credential providers to set multiple authentication action entries, and set a title for each.
  • Remove all privileged request classes. Providers can now simply get the origin from android.service.credentials.CallingAppInfo class, and do not need to handle special request classes for privileged calls (calls on behalf of another app).

Version 1.2.0-alpha01

February 8, 2023

androidx.credentials:credentials:1.2.0-alpha01 and androidx.credentials:credentials-play-services-auth:1.2.0-alpha01 are released. Version 1.2.0-alpha01 contains these commits.

New Features

  • This release added a new set of APIs for supporting Credential Provider in storing and fetching passwords, passkeys per users’ requests.

API Changes

  • New APIs added to support Credential Providers.

Version 1.0

Version 1.0.0-alpha05

March 22, 2023

androidx.credentials:credentials:1.0.0-alpha05 and androidx.credentials:credentials-play-services-auth:1.0.0-alpha05 are released. Version 1.0.0-alpha05 contains these commits.

Bug Fixes

  • Properly report the user cancellation error when the user cancels the modal sheet. (/I9ff3, b/271863184)

Version 1.0.0-alpha04

March 8, 2023

androidx.credentials:credentials:1.0.0-alpha04 and androidx.credentials:credentials-play-services-auth:1.0.0-alpha04 are released. Version 1.0.0-alpha04 contains these commits.

API Changes

  • Added android.permission.CREDENTIAL_MANAGER_SET_ORIGIN requirement for setting origin in Jetpack Library. (Ibaad4)
  • Added passkey get flow exceptions (I4f654)
  • CredentialManager api autoselect behavior update (I576dd)
  • CreateCredentialRequest.DisplayInfo now uses CharSequence rather than String fields. (I85e70)

Bug Fixes

  • Add proguard rules to ensure the play auth module won't be removed by R8. (9543977)

Version 1.0.0-alpha03

February 22, 2023

androidx.credentials:credentials:1.0.0-alpha03 and androidx.credentials:credentials-play-services-auth:1.0.0-alpha03 are released. Version 1.0.0-alpha03 contains these commits.

New Features

  • Added support for Sign-in with Google.

API Changes

  • Allows UnsupportedException to function correctly (I68208)
  • Adding a new exception type to account for cases such as when the device does not contain the necessary flags (If08dd)
  • CredentialManager exception api (I72947)

Version 1.0.0-alpha02

February 8, 2023

androidx.credentials:credentials:1.0.0-alpha02 and androidx.credentials:credentials-play-services-auth:1.0.0-alpha02 are released. Version 1.0.0-alpha02 contains these commits.

API Changes

  • CredentialManager api signature changes (Iabdec)
  • CredentialManager api signature changes (I977ed)
  • CredentialManager api signature changes (Ia6e9b)

Bug Fixes

  • Older ‘cable’ is no longer supported in the webauthn spec, and its replacement, ‘hybrid’ is now returned for the transport list.
  • Transports were given back in two dimensional lists, this has been fixed to be the correct 1d list.

Version 1.0.0-alpha01

January 11, 2023

androidx.credentials:credentials:1.0.0-alpha01 and androidx.credentials:credentials-play-services-auth:1.0.0-alpha01 are released. Version 1.0.0-alpha01 contains these commits.

New Features

  • This release contains a new jetpack library which provides a unified access to a user's credentials. This can include passwords, passkeys and federated credentials. This library should be used to provide seamless and secure sign-in experiences.
  • `androidx.credentials:credentials-play-services-auth:1.0.0-alpha01 ‘ is an optional library that allows credentials to be stored to, and retrieved from Google Password Manager. This dependency is needed for devices running Android API level <= 33.

API Changes

  • New library with new APIs