auth-foundation/com.okta.authfoundation.credential.kmp/Credential

Credential

interface Credential : CredentialIdentifier

Cross-platform credential interface providing token management operations.

Instances are immutable snapshots: token, tags, and id never change after construction. Methods that modify credential state return a Result containing a new Credential snapshot.

On JVM and other KMP targets, CredentialImpl is the implementation. The Android-only com.okta.authfoundation.credential.Credential is a separate, deprecated type that shares only the CredentialIdentifier contract — it does not implement this interface.

Inheritors

CredentialImpl

Properties

abstract override val id: String

Unique identifier for this credential.

Functions

accessTokenIfNotExpired

abstract fun accessTokenIfNotExpired(): String?

Returns the access token string if it has not expired, or null if it has.

deleteAsync

abstract suspend fun deleteAsync(): ERROR CLASS: Symbol not found for Result<kotlin/Unit>

Deletes this credential from storage.

getTokenFlow

abstract fun getTokenFlow(): ERROR CLASS: Symbol not found for Flow<com/okta/authfoundation/client/TokenInfo>

Returns a Flow that emits the current token and subsequent updates.

getUserInfo

abstract suspend fun getUserInfo(): ERROR CLASS: Symbol not found for Result<com/okta/authfoundation/client/dto/OidcUserInfo>

Fetches user info from the authorization server.

idToken

abstract fun idToken(): ERROR CLASS: Symbol not found for Result<com/okta/authfoundation/jwt/Jwt>

Retrieves the parsed Jwt from the ID token.

introspectToken

abstract suspend fun introspectToken(tokenType: TokenType): ERROR CLASS: Symbol not found for Result<com/okta/authfoundation/client/dto/IntrospectInfo>

Introspects a specific token type at the authorization server.

refreshIfExpired

abstract suspend fun refreshIfExpired(): ERROR CLASS: Symbol not found for Result<com/okta/authfoundation/credential/kmp/Credential>

Ensures the credential has a non-expired access token, refreshing if necessary.

refreshToken

abstract suspend fun refreshToken(): ERROR CLASS: Symbol not found for Result<com/okta/authfoundation/credential/kmp/Credential>

Refreshes the token and returns a new credential snapshot.

open suspend fun refreshToken(extraRequestParameters: Map<String, String>): ERROR CLASS: Symbol not found for Result<com/okta/authfoundation/credential/kmp/Credential>

Refreshes the token with additional form body parameters and returns a new credential snapshot.

revokeAllTokens

abstract suspend fun revokeAllTokens(): ERROR CLASS: Symbol not found for Result<kotlin/Unit>

Revokes all available token types (access token, refresh token, device secret).

revokeToken

abstract suspend fun revokeToken(tokenType: RevokeTokenType): ERROR CLASS: Symbol not found for Result<kotlin/Unit>

Revokes a specific token type at the authorization server.

scope

abstract fun scope(): List<String>

Returns the scopes associated with the token, or the client's default scopes. Pure read.

setTagsAsync

abstract suspend fun setTagsAsync(tags: Map<String, String>): ERROR CLASS: Symbol not found for Result<com/okta/authfoundation/credential/kmp/Credential>

Updates the tags for this credential and returns a new snapshot.