Credential Manager Documentation

Overview

Android iOS

Credential Manager is a Jetpack API that supports multiple sign-in methods, such as username and password, passkeys, and federated sign-in solutions (like Sign-in with Google) in a single API, simplifying integration for developers on Android. For iOS, it uses Keychain for storing credentials.

Breaking Changes

  • Removed Encrypted Credentials for Android, as it was using old API and not needed Credentials API are enough to handle all.
  • getPasswordCredentials changed to getCredentials for both Android and iOS, as now it will return only PasskeyCredential on iOS and on Android it will return all the types of credentials that are saved and parameter passed into function.

Getting Started

dependencies:
  credential_manager: <latest_version>

Or run:

flutter pub add credential_manager

Android Setup

  1. Add proguard rules:

    -if class androidx.credentials.CredentialManager
-keep class androidx.credentials.playservices.** {
  *;
}

  2. Update android/app/build.gradle:

    android {
  buildTypes {
    release {
      minifyEnabled true
      proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
  }
}

iOS Setup

  1. Add Associated Domain to XCode

    iOS Associated Domain

  2. Configure Apple App Site Association

    iOS Apple App Site Association
  3. Enable Keychain Sharing in XCode using sign and capabilities tab.

Note: Passkey is a new feature introduced by Apple in iOS 16 and later versions. It provides a more secure and convenient way to handle credentials. This plugin supports passkey operations such as saving and retrieving passkey credentials on iOS 16+ devices. Make sure your app is targeting iOS 16 or higher to utilize this feature.

Visual Examples

Android AutoFill Service

Get Credential 1 Google Save Credential 1 Get Google/Password Saved Credential Get Google/Password Saved Credential Success

iOS AutoFill Service

iOS Credential 1 iOS Credential 2

Passkey Examples

Android

Passkey Creation Passkey Success

iOS

Upcoming Features

Contributors

Djsmk123

Djsmk123

jlafazia-figure

jlafazia-figure

wildsylvan

wildsylvan

Granfalloner

Granfalloner

React Native Plugin

For React Native developers, a similar plugin is available to integrate Credential Manager into your React Native applications. You can find the repository and installation instructions on GitHub:

React Native Credential Manager Plugin