CredentialManager

default void clearCredentialState(@NonNull ClearCredentialStateRequest request)

Clears the current user credential state from all credential providers.

You should invoked this api after your user signs out of your app to notify all credential providers that any stored credential session for the given app should be cleared.

A credential provider may have stored an active credential session and use it to limit sign-in options for future get-credential calls. For example, it may prioritize the active credential over any other available credential. When your user explicitly signs out of your app and in order to get the holistic sign-in options the next time, you should call this API to let the provider clear any stored credential session.

If the API is called with ClearCredentialStateRequest.TYPE_CLEAR_RESTORE_CREDENTIAL then any restore credential stored on device will be cleared.

abstract void clearCredentialStateAsync(
    @NonNull ClearCredentialStateRequest request,
    CancellationSignal cancellationSignal,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<Void, @NonNull ClearCredentialException> callback
)

Clears the current user credential state from all credential providers.

This API uses callbacks instead of Kotlin coroutines.

You should invoked this api after your user signs out of your app to notify all credential providers that any stored credential session for the given app should be cleared.

A credential provider may have stored an active credential session and use it to limit sign-in options for future get-credential calls. For example, it may prioritize the active credential over any other available credential. When your user explicitly signs out of your app and in order to get the holistic sign-in options the next time, you should call this API to let the provider clear any stored credential session.

default static final @NonNull CredentialManager create(@NonNull Context context)

Creates a CredentialManager based on the given context.

default @NonNull CreateCredentialResponse createCredential(
    @NonNull Context context,
    @NonNull CreateCredentialRequest request
)

Registers a user credential that can be used to authenticate the user to the app in the future.

The execution potentially launches framework UI flows for a user to view their registration options, grant consent, etc.

abstract void createCredentialAsync(
    @NonNull Context context,
    @NonNull CreateCredentialRequest request,
    CancellationSignal cancellationSignal,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<@NonNull CreateCredentialResponse, @NonNull CreateCredentialException> callback
)

Registers a user credential that can be used to authenticate the user to the app in the future.

This API uses callbacks instead of Kotlin coroutines.

The execution potentially launches framework UI flows for a user to view their registration options, grant consent, etc.

@RequiresApi(value = 34)
abstract @NonNull PendingIntent createSettingsPendingIntent()

Returns a pending intent that shows a screen that lets a user enable a Credential Manager provider.

@RequiresApi(value = 34)
default @NonNull GetCredentialResponse getCredential(
    @NonNull Context context,
    @NonNull PrepareGetCredentialResponse.PendingGetCredentialHandle pendingGetCredentialHandle
)

Requests a credential from the user.

Different from the other getCredential(GetCredentialRequest, Activity) API, this API launches the remaining flows to retrieve an app credential from the user, after the completed prefetch work corresponding to the given pendingGetCredentialHandle. Use this API to complete the full credential retrieval operation after you initiated a request through the prepareGetCredential API.

The execution can potentially launch UI flows to collect user consent to using a credential, display a picker when multiple credentials exist, etc.

default @NonNull GetCredentialResponse getCredential(
    @NonNull Context context,
    @NonNull GetCredentialRequest request
)

Requests a credential from the user.

The execution potentially launches framework UI flows for a user to view available credentials, consent to using one of them, etc.

import androidx.credentials.Credential
import androidx.credentials.CredentialManager
import androidx.credentials.GetCredentialRequest
import androidx.credentials.GetPasswordOption
import androidx.credentials.GetPublicKeyCredentialOption
import androidx.credentials.PublicKeyCredential
import androidx.credentials.exceptions.GetCredentialException

val credentialManager = CredentialManager.create(context)

val getPasswordOption = GetPasswordOption()

val getPublicKeyCredentialOption =
    GetPublicKeyCredentialOption(
        requestJson = generateGetPasskeyRequestJsonFromServer(),
        // No need to fill this unless you are a browser and are making an origin-based request
        clientDataHash = null,
    )

val request =
    GetCredentialRequest(
        credentialOptions = listOf(getPasswordOption, getPublicKeyCredentialOption)
    )

// The API call will launch a credential selector UI for the user to pick a login credential.
// It will be canceled if this coroutine scope is canceled. If you want the operation to persist
// through your UI lifecycle (e.g. configuration changes), choose a coroutine scope that is
// broader than your UI lifecycle (e.g. ViewModelScope)
yourCoroutineScope.launch {
    try {
        val response =
            credentialManager.getCredential(
                // Important: use an Activity context to ensure that the system credential
                // selector
                // ui is launched within the same activity stack to avoid undefined UI
                // transition
                // behavior.
                context = activity,
                request = request,
            )
        signInWithCredential(response.credential)
    } catch (e: GetCredentialException) {
        handleGetCredentialFailure(e)
    }
}

@RequiresApi(value = 34)
abstract void getCredentialAsync(
    @NonNull Context context,
    @NonNull PrepareGetCredentialResponse.PendingGetCredentialHandle pendingGetCredentialHandle,
    CancellationSignal cancellationSignal,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<@NonNull GetCredentialResponse, @NonNull GetCredentialException> callback
)

Requests a credential from the user.

This API uses callbacks instead of Kotlin coroutines.

Different from the other getCredentialAsync(GetCredentialRequest, Activity) API, this API launches the remaining flows to retrieve an app credential from the user, after the completed prefetch work corresponding to the given pendingGetCredentialHandle. Use this API to complete the full credential retrieval operation after you initiated a request through the prepareGetCredentialAsync API.

The execution can potentially launch UI flows to collect user consent to using a credential, display a picker when multiple credentials exist, etc.

abstract void getCredentialAsync(
    @NonNull Context context,
    @NonNull GetCredentialRequest request,
    CancellationSignal cancellationSignal,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<@NonNull GetCredentialResponse, @NonNull GetCredentialException> callback
)

Requests a credential from the user.

This API uses callbacks instead of Kotlin coroutines.

The execution potentially launches framework UI flows for a user to view available credentials, consent to using one of them, etc.

@RequiresApi(value = 34)
default @NonNull PrepareGetCredentialResponse prepareGetCredential(@NonNull GetCredentialRequest request)

Prepares for a get-credential operation. Returns a PrepareGetCredentialResponse that can later be used to launch the credential retrieval UI flow to finalize a user credential for your app.

This API doesn't invoke any UI. It only performs the preparation work so that you can later launch the remaining get-credential operation (involves UIs) through the getCredential API which incurs less latency than executing the whole operation in one call.

@RequiresApi(value = 34)
abstract void prepareGetCredentialAsync(
    @NonNull GetCredentialRequest request,
    CancellationSignal cancellationSignal,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<@NonNull PrepareGetCredentialResponse, @NonNull GetCredentialException> callback
)

Prepares for a get-credential operation. Returns a PrepareGetCredentialResponse that can later be used to launch the credential retrieval UI flow to finalize a user credential for your app.

This API uses callbacks instead of Kotlin coroutines.

This API doesn't invoke any UI. It only performs the preparation work so that you can later launch the remaining get-credential operation (involves UIs) through the getCredentialAsync API which incurs less latency than executing the whole operation in one call.

default @NonNull SignalCredentialStateResponse signalCredentialState(@NonNull SignalCredentialStateRequest request)

Signals a user's public key credential/credentials state to all credential providers.

The execution does not invoke any UI but simply informs credential providers about the state of a user's credential. Supported signal types are SignalAllAcceptedCredentialIdsRequest, SignalCurrentUserDetailsRequest, SignalUnknownCredentialRequest.

A successful response does not indicate that any provider honored the signal request; it however indicates that the request was well-formed, passes all necessary checks, and has been passed along to all enabled providers, if any.

default void signalCredentialStateAsync(
    @NonNull SignalCredentialStateRequest request,
    @NonNull Executor executor,
    @NonNull CredentialManagerCallback<@NonNull SignalCredentialStateResponse, @NonNull SignalCredentialStateException> callback
)

Signals a user's public key credential/credentials state to all credential providers.

This API uses callbacks instead of Kotlin coroutines.

The execution does not invoke any UI but simply informs credential providers about the state of a user's credential. Supported signal types are SignalAllAcceptedCredentialIdsRequest, SignalCurrentUserDetailsRequest, SignalUnknownCredentialRequest.

A successful response does not indicate that any provider honored the signal request; it however indicates that the request was well-formed, passes all necessary checks, and has been passed along to all enabled providers, if any.