Stay organized with collections
Save and categorize content based on your preferences.
To integrate Smart Lock for Passwords into your Android app, you must add calls
to the Credentials API
to your app's start-up and sign-in flow. The following diagram shows the flow of
a typical Android app that uses Smart Lock for Passwords.
While there are many ways to successfully integrate Smart Lock for Passwords,
and the specifics of an integration depend on the structure and user experience
of the app, the following flow is recommended for most apps. Apps that use this
flow have these user experience advantages:
Existing users of your service that have a single credential saved are
immediately signed in, and they will go directly to the signed-in view when
they open the app.
Users that have multiple credentials saved or that have disabled automatic
sign-in need to respond to only one dialog before they go to the app's
signed-in view.
Users that have no saved credentials or haven't signed up yet
can pick their name and email with a single tap and be intelligently sent to
either the sign-in or sign-up view, with this information pre-filled.
When users sign out, the app ensures they are not automatically signed back
in.
Retrieve credentials
When the app starts, if no user is already signed in, call
CredentialsClient.request().
If the Task is successful, get the user's credentials with
getResult().getCredential() and use them to sign in.
If the Task fails and
the exception is an instance of ResolvableApiException and
getStatusCode() returns RESOLUTION_REQUIRED,
user input is required to pick a credential. Call
startResolutionForResult() to prompt the user to select a
saved account, then call
getParcelableExtra(Credential.EXTRA_KEY) to get the user's
credentials and use them to sign in.
Save credentials
If the Task fails with an ApiException and
getStatusCode() returns SIGN_IN_REQUIRED, the
user has no saved credentials and must sign in or sign up manually using
your current sign-in or sign-up flow. After the user successfully
completes sign in, you can provide an opportunity for the user to save
their credentials for future retrieval (step 5).
You can help the user sign in or sign up faster and more
easily by retrieving sign-in hints, such as the user's email address. The
user can select the hint and skip typing their credentials. If your app
requires users to sign in, you might choose to retrieve hints immediately
after the initial credentials request fails (otherwise, you can wait until
the user starts the sign-in or sign-up flow).
Call CredentialsClient.getHintPickerIntent() and start the
intent to prompt the user to select an account, then call
getParcelableExtra(Credential.EXTRA_KEY) to get the
sign-in hint.
If the user ID of the hint matches an existing user, pre-fill the
sign-in form with it and let the user enter the password to sign
in.
If the user ID of the hint doesn't match an existing user, pre-fill
the sign-up form with the user's ID and name, and let the user
create a new account.
After the user successfully signs in or creates an account, save the user
ID and password with CredentialsClient.save().
If the user signed in with a federated identity provider such as Google
Sign-In, create the Credential object with the user's email
address as the ID and specify the identity provider with
setAccountType.
Sign out
When the user signs out, call CredentialsClient.disableAutoSignIn()
to prevent the user from being immediately signed back in. Disabling
auto-sign-in also enables users to switch between accounts easily—for
example, between work and personal accounts, or between accounts on shared
devices—without having to re-enter their sign-in information.
Ready to integrate Smart Lock for Passwords into your app?
Get started.
[[["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 2024-10-31 UTC."],[[["\u003cp\u003eSmart Lock for Passwords is deprecated; migrate to Credential Manager for enhanced security and user experience with passkeys, passwords, and federated identities.\u003c/p\u003e\n"],["\u003cp\u003eSmart Lock for Passwords integration involves adding the Credentials API to your app's startup and sign-in flow to retrieve and save user credentials.\u003c/p\u003e\n"],["\u003cp\u003eExisting users with saved credentials can experience automatic sign-in, while new users can benefit from pre-filled forms using sign-in hints.\u003c/p\u003e\n"],["\u003cp\u003eEnsure to disable auto-sign-in upon user sign-out to prevent immediate re-authentication and facilitate account switching.\u003c/p\u003e\n"]]],[],null,["# Android integration flow\n\n| **Deprecated:** Smart Lock for Passwords is deprecated. To ensure the continued security and usability of your app, [migrate to\n| Credential Manager](https://developer.android.com/training/sign-in/passkeys/) today. Credential Manager supports passkey, password, and federated identity authentication (such as Sign-in with Google), stronger security, and a more consistent user experience.\n\nTo integrate Smart Lock for Passwords into your Android app, you must add calls\nto the [Credentials API](/android/reference/com/google/android/gms/auth/api/credentials/package-summary)\nto your app's start-up and sign-in flow. The following diagram shows the flow of\na typical Android app that uses Smart Lock for Passwords.\n\nWhile there are many ways to successfully integrate Smart Lock for Passwords,\nand the specifics of an integration depend on the structure and user experience\nof the app, the following flow is recommended for most apps. Apps that use this\nflow have these user experience advantages:\n\n- Existing users of your service that have a single credential saved are immediately signed in, and they will go directly to the signed-in view when they open the app.\n- Users that have multiple credentials saved or that have disabled automatic sign-in need to respond to only one dialog before they go to the app's signed-in view.\n- Users that have no saved credentials or haven't signed up yet can pick their name and email with a single tap and be intelligently sent to either the sign-in or sign-up view, with this information pre-filled.\n- When users sign out, the app ensures they are not automatically signed back in.\n\n[](/static/identity/smartlock-passwords/android/images/smartlock-passwords-flow.png)\n\n### Retrieve credentials\n\n1. When the app starts, if no user is already signed in, call `CredentialsClient.request()`.\n2. If the `Task` is successful, get the user's credentials with `getResult().getCredential()` and use them to sign in.\n3. If the `Task` fails and the exception is an instance of `ResolvableApiException` and `getStatusCode()` returns `RESOLUTION_REQUIRED`, user input is required to pick a credential. Call `startResolutionForResult()` to prompt the user to select a saved account, then call `getParcelableExtra(Credential.EXTRA_KEY)` to get the user's credentials and use them to sign in. If signing in with the retrieved credentials fails because the password is incorrect or the account doesn't exist, delete the credentials from Smart Lock with `CredentialsClient.delete()`.\n\n### Save credentials\n\n4. If the `Task` fails with an `ApiException` and\n `getStatusCode()` returns `SIGN_IN_REQUIRED`, the\n user has no saved credentials and must sign in or sign up manually using\n your current sign-in or sign-up flow. After the user successfully\n completes sign in, you can provide an opportunity for the user to save\n their credentials for future retrieval (step 5).\n\n You can help the user sign in or sign up faster and more\n easily by retrieving sign-in hints, such as the user's email address. The\n user can select the hint and skip typing their credentials. If your app\n requires users to sign in, you might choose to retrieve hints immediately\n after the initial credentials request fails (otherwise, you can wait until\n the user starts the sign-in or sign-up flow).\n 1. Call `CredentialsClient.getHintPickerIntent()` and start the intent to prompt the user to select an account, then call `getParcelableExtra(Credential.EXTRA_KEY)` to get the sign-in hint.\n 2. If the user ID of the hint matches an existing user, pre-fill the sign-in form with it and let the user enter the password to sign in.\n 3. If the user ID of the hint doesn't match an existing user, pre-fill the sign-up form with the user's ID and name, and let the user create a new account.\n5. After the user successfully signs in or creates an account, save the user\n ID and password with `CredentialsClient.save()`.\n\n If the user signed in with a federated identity provider such as Google\n Sign-In, create the `Credential` object with the user's email\n address as the ID and specify the identity provider with\n `setAccountType`.\n\n### Sign out\n\n6. When the user signs out, call `CredentialsClient.disableAutoSignIn()` to prevent the user from being immediately signed back in. Disabling auto-sign-in also enables users to switch between accounts easily---for example, between work and personal accounts, or between accounts on shared devices---without having to re-enter their sign-in information.\n\nReady to integrate Smart Lock for Passwords into your app?\n[Get started](/identity/smartlock-passwords/android/get-started)."]]
