auth-foundation/com.okta.authfoundation.credential

Package-level declarations

Types

class BiometricInvocationException(val message: String?) : IllegalStateException

Thrown when fetching a Credential with Biometric security using a synchronous Credential function. Biometric Credentials should only be fetched using Async functions in Credential.

Credential

class Credential : CredentialIdentifier

Convenience object that wraps a Token, providing methods and properties for interacting with credential resources.

CredentialDataSource

class CredentialDataSource(storage: TokenStorage)

CredentialIdentifier

interface CredentialIdentifier

Minimal identity contract for credentials.

DefaultTokenEncryptionHandler

class DefaultTokenEncryptionHandler(keyStore: KeyStore = AndroidKeystoreUtil.keyStore, keyPairGenerator: KeyPairGenerator = AndroidKeystoreUtil.getRsaKeyPairGenerator()) : TokenEncryptionHandler

LegacyTokenStorage

interface LegacyTokenStorage

Legacy interface used to customize the way tokens are stored, updated, and removed throughout the lifecycle of an application. See TokenStorage for the current version.

RevokeAllException

class RevokeAllException : Exception

The exception in OAuth2ClientResult.Error when a call to Credential.revokeAllTokens fails.

RevokeTokenType

enum RevokeTokenType : Enum<RevokeTokenType>

The possible token types that can be revoked.

RoomTokenStorage

class RoomTokenStorage(tokenDatabase: TokenDatabase, tokenEncryptionHandler: TokenEncryptionHandler) : TokenStorage

Token

@Serializable

class Token : TokenInfo

Token information representing a user's access to a resource server, including access token, refresh token, and other related information.

TokenDbRecoveryUtil

object TokenDbRecoveryUtil

TokenEncryptionHandler

interface TokenEncryptionHandler

Interface for defining how Tokens are encrypted before storing in RoomTokenStorage, the default implementation of TokenStorage.

TokenMetadata

data class TokenMetadata(val id: String, val tags: Map<String, String>, val payloadData: ERROR CLASS: Symbol not found for JsonObject??, val json: ERROR CLASS: Symbol not found for Json = Json { ignoreUnknownKeys = true })

Non-sensitive information about a token to be used in storage.

TokenStorage

interface TokenStorage

Interface used to customize the way tokens are stored, updated, and removed throughout the lifecycle of an application.

TokenType

enum TokenType : Enum<TokenType>

The type of token an operation should be used with.