Stay organized with collections
Save and categorize content based on your preferences.
credentials registry
To solve for these, we are adding a new registry mechanism that allows an app to provide digital credentials in a privacy-preserving way. At a high level, the provider app will be pre-registering all their candidate digital credentials with the Credential Manager; When Credential Manager receives an app request for a specific digital credential, it will run the credential matching and user selector UI in a sandbox.
Latest Update |
Stable Release |
Release Candidate |
Beta Release |
Alpha Release |
October 16, 2024 |
- |
- |
- |
1.0.0-alpha01 |
Declaring dependencies
To add a dependency on credentials registry, 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 {
// Use to implement credentials registrys
implementation "androidx.credentials.registry:registry-digitalcredentials-mdoc:1.0.0-alpha01"
implementation "androidx.credentials.registry:registry-digitalcredentials-preview:1.0.0-alpha01"
implementation "androidx.credentials.registry:registry-provider:1.0.0-alpha01"
implementation "androidx.credentials.registry:registry-provider-play-services:1.0.0-alpha01"
}
Kotlin
dependencies {
// Use to implement credentials registrys
implementation("androidx.credentials.registry:registry-digitalcredentials-mdoc:1.0.0-alpha01")
implementation("androidx.credentials.registry:registry-digitalcredentials-preview:1.0.0-alpha01")
implementation("androidx.credentials.registry:registry-provider:1.0.0-alpha01")
implementation("androidx.credentials.registry:registry-provider-play-services:1.0.0-alpha01")
}
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.
Credentials Registry 1.0
Version 1.0.0-alpha01
October 16, 2024
androidx.credentials.registry:registry-*:1.0.0-alpha01
is released. Version 1.0.0-alpha01 contains these commits.
New Features
- New Credential Manager provider registry support: allow providers to pre-register credential metadata with Credential Manager which can be later surfaced to the user by the Credential Manager upon an incoming app request.
- Added ISO/IEC mdoc credential APIs for registering mdoc credentials
- Also added a preview protocol based registry to demonstrate the end-to-end capability
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-05-29 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-05-29 UTC."],[],[],null,["# credentials registry\n====================\n\nAPI Reference \n[androidx.credentials.registry](/reference/kotlin/androidx/credentials/registry/package-summary) \nTo solve for these, we are adding a new registry mechanism that allows an app to provide digital credentials in a privacy-preserving way. At a high level, the provider app will be pre-registering all their candidate digital credentials with the Credential Manager; When Credential Manager receives an app request for a specific digital credential, it will run the credential matching and user selector UI in a sandbox. \n\n| Latest Update | Stable Release | Release Candidate | Beta Release | Alpha Release |\n|------------------|----------------|-------------------|--------------|--------------------------------------------------------------------------------|\n| October 16, 2024 | - | - | - | [1.0.0-alpha01](/jetpack/androidx/releases/credentials-registry#1.0.0-alpha01) |\n\nDeclaring dependencies\n----------------------\n\nTo add a dependency on credentials registry, you must add the Google Maven repository to your\nproject. Read [Google's Maven repository](/studio/build/dependencies#google-maven)\nfor more information.\n\nAdd the dependencies for the artifacts you need in the `build.gradle` file for\nyour app or module: \n\n### Groovy\n\n```groovy\ndependencies {\n // Use to implement credentials registrys\n\n implementation \"androidx.credentials.registry:registry-digitalcredentials-mdoc:1.0.0-alpha01\"\n implementation \"androidx.credentials.registry:registry-digitalcredentials-preview:1.0.0-alpha01\"\n implementation \"androidx.credentials.registry:registry-provider:1.0.0-alpha01\"\n implementation \"androidx.credentials.registry:registry-provider-play-services:1.0.0-alpha01\"\n\n}\n```\n\n### Kotlin\n\n```kotlin\ndependencies {\n // Use to implement credentials registrys\n\n implementation(\"androidx.credentials.registry:registry-digitalcredentials-mdoc:1.0.0-alpha01\")\n implementation(\"androidx.credentials.registry:registry-digitalcredentials-preview:1.0.0-alpha01\")\n implementation(\"androidx.credentials.registry:registry-provider:1.0.0-alpha01\")\n implementation(\"androidx.credentials.registry:registry-provider-play-services:1.0.0-alpha01\")\n\n}\n```\n\nFor more information about dependencies, see [Add build dependencies](/studio/build/dependencies).\n\nFeedback\n--------\n\nYour feedback helps make Jetpack better. Let us know if you discover new issues or have\nideas for improving this library. Please take a look at the\n[existing issues](https://issuetracker.google.com/issues?q=componentid:1301097%20status:open)\nin this library before you create a new one. You can add your vote to an existing issue by\nclicking the star button.\n\n[Create a new issue](https://issuetracker.google.com/issues/new?component=1301097&template=1773864)\n\nSee the [Issue Tracker documentation](https://developers.google.com/issue-tracker)\nfor more information.\n\nCredentials Registry 1.0\n------------------------\n\n### Version 1.0.0-alpha01\n\nOctober 16, 2024\n\n`androidx.credentials.registry:registry-*:1.0.0-alpha01` is released. Version 1.0.0-alpha01 contains [these commits](https://android.googlesource.com/platform/frameworks/support/+log/b8a68b0896897fa158508d73a31998a26161d9a7/credentials/registry).\n\n**New Features**\n\n- New Credential Manager provider registry support: allow providers to pre-register credential metadata with Credential Manager which can be later surfaced to the user by the Credential Manager upon an incoming app request.\n- Added ISO/IEC mdoc credential APIs for registering mdoc credentials\n- Also added a preview protocol based registry to demonstrate the end-to-end capability"]]