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

Credential

class ~~Credential~~ : CredentialIdentifier

Deprecated

Credential is deprecated in favor of the KMP variant, which works on Android and JVM. Use com.okta.authfoundation.credential.kmp.TokenCredentialManager to manage credentials, and com.okta.authfoundation.credential.kmp.Credential for the resulting immutable snapshots. This class will be removed in a future major release.

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

This class can be used as a convenience mechanism for managing stored credentials, performing operations on or for a user using their credentials, and interacting with resources scoped to the credential.

Note: Credential itself never invokes biometric authentication directly; all biometric-gated token decryption is delegated entirely to TokenEncryptionHandler (which, in turn, uses BiometricAuthenticator/AndroidBiometricAuthenticator).

Types

Companion

object Companion

Security

sealed interface Security

Convenience object for specifying security level for storing Token objects

Properties

open override val id: String

Identifier for this credential.

Functions

accessTokenInterceptor

fun accessTokenInterceptor(): Interceptor

Returns an Interceptor that can be can be added to an OkHttpClient via OkHttpClient.Builder.addInterceptor to access a Resource Server.

delete

fun delete()

Removes this Credential from the associated CredentialDataSource. This Credential should not be used after it's been removed.

deleteAsync

suspend fun deleteAsync()

Removes this Credential from the associated CredentialDataSource. This Credential should not be used after it's been removed.

equals

open operator override fun equals(other: Any?): Boolean

getAccessTokenIfValid

fun getAccessTokenIfValid(): String?

Checks to see if the current access token is valid, and if it is, returns it. If there is no Token associated with the Credential, null is returned.

getTokenFlow

fun getTokenFlow(): Flow<Token>

Returns a Flow that emits the current Token that's stored and associated with this Credential.

getUserInfo

suspend fun getUserInfo(): OAuth2ClientResult<OidcUserInfo>

Performs the OIDC User Info call, which returns claims associated with this Credential.

getValidAccessToken

suspend fun getValidAccessToken(): String?

Returns a valid access token if one is present. If the access token is invalid, and there is a refresh token, a Token refresh is attempted via Credential.refreshToken. If the refresh results in a valid access token, it is returned.

hashCode

open override fun hashCode(): Int

idToken

fun idToken(): Jwt?

Retrieve the Jwt associated with the Token.idToken field.

introspectToken

suspend fun introspectToken(tokenType: TokenType): OAuth2ClientResult<OidcIntrospectInfo>

Performs a call to the Authorization Server to validate the specified TokenType.

refreshToken

suspend fun refreshToken(): OAuth2ClientResult<Token>

Attempt to refresh the Token associated with this Credential.

suspend fun refreshToken(extraRequestParameters: Map<String, String>): OAuth2ClientResult<Token>

Attempt to refresh the Token associated with this Credential, forwarding additional form body parameters to the token endpoint.

revokeAllTokens

suspend fun revokeAllTokens(): OAuth2ClientResult<Unit>

Attempt to revoke all available tokens.

revokeToken

suspend fun revokeToken(tokenType: RevokeTokenType): OAuth2ClientResult<Unit>

Attempt to revoke the specified TokenType.

scope

fun scope(): String

Returns the scopes associated with the associated Token if present, otherwise the default scopes associated with the OAuth2Client.

scopes

fun scopes(): List<String>

Returns the scopes associated with the associated Token if present, otherwise the default scopes associated with the OAuth2Client, as a list.

setTagsAsync

suspend fun setTagsAsync(tags: Map<String, String>)

Set tags for this Credential.