BiometricKeyInvalidatedException

class BiometricKeyInvalidatedException(val tokenId: String, val keyAlias: String) : Exception

Thrown when the biometric key protecting a stored token has been permanently invalidated — for example, after the user enrolls a new biometric on the device.

On the Android platform, this is surfaced as Result.failure from TokenStorage.getToken instead of the platform-specific KeyPermanentlyInvalidatedException.

On the legacy Android-only com.okta.authfoundation.credential.RoomTokenStorage path, the invalidated token is auto-deleted by default for backward compatibility (matching the legacy BiometricTokenInvalidatedEvent.deleteInvalidatedToken = true default); deletion is no longer required there unless the app has suppressed the legacy event's default behavior.

On the KMP TokenCredentialManager/TokenStorage path — including com.okta.authfoundation.credential.kmp.AndroidTokenEncryptionHandler-backed storage — there is no auto-delete: the caller must inspect tokenId and explicitly remove the token from storage (e.g. via TokenCredentialManager.get(tokenId)'s associated credential) if that behavior is desired.

Parameters

tokenId

the ID of the token whose biometric key was invalidated.

keyAlias

the platform-specific alias of the invalidated key.

Constructors

Link copied to clipboard
constructor(tokenId: String, keyAlias: String)

Properties

Link copied to clipboard
open val cause: Throwable?
Link copied to clipboard
Link copied to clipboard
open val message: String?
Link copied to clipboard