Clerk Android API/com.clerk.api.restorecredentials/RestoreCredentials

RestoreCredentials

The main entry point for Google Play Restore Credentials operations.

Access via Clerk.restoreCredentials. Restore credentials use Android Credential Manager to create a system-managed restore key for the current user and silently redeem that key after the app is transferred to a new Android device.

Functions

clear

suspend fun clear(): ClerkResult<Unit, ClerkErrorResponse>

Deletes the app's restore credential from this device and its cloud backup.

create

suspend fun create(isCloudBackupEnabled: Boolean = true): ClerkResult<Unit, ClerkErrorResponse>

Creates a restore credential for the current signed-in user.

signIn

suspend fun signIn(): ClerkResult<SignIn, ClerkErrorResponse>

Silently signs in with a restore credential transferred by Android device setup.