Okta Mobile Kotlin SDK

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

OAuth2Client

class OAuth2Client

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

object Companion

Properties

val configuration: OidcConfiguration

Functions

endpointNotAvailableError

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

endpointsOrNull

suspend fun endpointsOrNull(): OidcEndpoints?

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.

suspend fun jwks(): OAuth2ClientResult<Jwks>

Performs a call to the Authorization Server to fetch Jwks.

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>

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

Attempt to refresh the token.

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

Attempt to revoke the specified token.

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