auth-foundation/com.okta.authfoundation.client/OAuth2Client

OAuth2Client

Deprecated

The Android-only OAuth2Client is deprecated in favor of the KMP variant, which works on Android and JVM. Build one via OAuth2ClientBuilder.create(issuerUrl, clientId, scope) and use com.okta.authfoundation.client.kmp.OAuth2Client instead. This class will be removed in a future major release.

The client used for interacting with an Okta Authorization Server.

This is for low level access, and it's typically preferred to use a Credential, which streamlines usage.

Okta Developer Docs

Types

Companion

object Companion

Properties

configuration

val configuration: OidcConfiguration

Functions

endpointNotAvailableError

fun <T> endpointNotAvailableError(): OAuth2ClientResult.Error<T>

endpointsOrNull

suspend fun endpointsOrNull(): OidcEndpoints?

getUserInfo

suspend fun getUserInfo(accessToken: String): OAuth2ClientResult<OidcUserInfo>

Performs the OIDC User Info call, which returns claims associated with the supplied accessToken.

introspectToken

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

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

jwks

suspend fun jwks(): OAuth2ClientResult<Jwks>

Performs a call to the Authorization Server to fetch Jwks.

performRequest

suspend fun OAuth2Client.performRequest(request: Request): OAuth2ClientResult<Response>

suspend fun <Raw, Dto> OAuth2Client.performRequest(deserializationStrategy: DeserializationStrategy<Raw>, request: Request, shouldAttemptJsonDeserialization: (Response) -> Boolean = { it.isSuccessful }, responseMapper: (Raw) -> Dto): OAuth2ClientResult<Dto>

refreshToken

suspend fun refreshToken(token: Token): OAuth2ClientResult<Token>

Attempt to refresh the token.

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

Attempt to refresh the token, forwarding additional form body parameters to the token endpoint.

revokeToken

suspend fun revokeToken(revokeTokenType: RevokeTokenType, token: Token): OAuth2ClientResult<Unit>

Attempt to revoke the specified token.

tokenRequest

suspend fun tokenRequest(request: Request, nonce: String? = null, maxAge: Int? = null, requestToken: Token? = null): OAuth2ClientResult<Token>