oauth2/com.okta.oauth2.kmp

Package-level declarations

Types

Encapsulates the behavior required to authenticate using the OIDC Authorization Code flow with PKCE.

data class AuthorizationCodeFlowContext(val url: String, val redirectUrl: String, codeVerifier: String, state: String, nonce: String, maxAge: Int?)

A model representing the context and current state for an authorization code session.

BrowserRedirectHandler

interface BrowserRedirectHandler

Abstracts browser launch and redirect capture for redirect-based OAuth2 flows.

DeviceAuthorizationFlow

interface DeviceAuthorizationFlow

Implements the Device Authorization Grant flow.

DeviceAuthorizationFlowContext

data class DeviceAuthorizationFlowContext(val verificationUri: String, val verificationUriComplete: String?, val userCode: String, val expiresIn: Int, deviceCode: String, interval: Int)

Holds the state for an in-progress DeviceAuthorizationFlow session.

LocalhostBrowserRedirectHandler

class LocalhostBrowserRedirectHandler(port: Int, path: String, timeoutMs: Long = DEFAULT_TIMEOUT_MS, browserLauncher: (String) -> Unit = Companion::defaultBrowserLauncher) : BrowserRedirectHandler

A BrowserRedirectHandler implementation for JVM that starts a localhost HTTP server, opens the system browser, and captures the redirect callback.

RedirectEndSessionFlow

interface RedirectEndSessionFlow

RedirectEndSessionFlow encapsulates the behavior required to log out using an OIDC browser redirect flow.

RedirectEndSessionFlowContext

data class RedirectEndSessionFlowContext(val url: String, val redirectUrl: String, state: String)

A model representing the context and current state for a redirect end-session flow.

ResourceOwnerFlow

interface ResourceOwnerFlow

An authentication flow that implements the Resource Owner Password Grant.

SessionTokenFlow

interface SessionTokenFlow

Implements the Session Token authentication flow.

TokenExchangeFlow

interface TokenExchangeFlow

Implements the Token Exchange flow for Native SSO.

Functions

AuthorizationCodeFlow

fun AuthorizationCodeFlow(client: OAuth2Client): AuthorizationCodeFlow

Creates a KMP AuthorizationCodeFlow backed by a new KMP OAuth2Client configured from this Android OAuth2Client's settings.

DeviceAuthorizationFlow

fun DeviceAuthorizationFlow(client: OAuth2Client): DeviceAuthorizationFlow

Creates a KMP DeviceAuthorizationFlow backed by a new KMP OAuth2Client configured from this Android OAuth2Client's settings.

RedirectEndSessionFlow

fun RedirectEndSessionFlow(client: OAuth2Client): RedirectEndSessionFlow

Creates a KMP RedirectEndSessionFlow backed by a new KMP OAuth2Client configured from this Android OAuth2Client's settings.

ResourceOwnerFlow

fun ResourceOwnerFlow(client: OAuth2Client): ResourceOwnerFlow

Creates a KMP ResourceOwnerFlow backed by a new KMP OAuth2Client configured from this Android OAuth2Client's settings.

resume

suspend fun AuthorizationCodeFlow.resume(uri: Uri, flowContext: AuthorizationCodeFlowContext): Result<TokenInfo>

Resumes the Authorization Code flow using an Android android.net.Uri.

fun RedirectEndSessionFlow.resume(uri: Uri, flowContext: RedirectEndSessionFlowContext): Result<Unit>

Resumes the Redirect End Session flow using an Android android.net.Uri.

SessionTokenFlow

fun SessionTokenFlow(client: OAuth2Client): SessionTokenFlow

Creates a KMP SessionTokenFlow backed by a new KMP OAuth2Client configured from this Android OAuth2Client's settings.

TokenExchangeFlow

fun TokenExchangeFlow(client: OAuth2Client): TokenExchangeFlow

Creates a KMP TokenExchangeFlow backed by a new KMP OAuth2Client configured from this Android OAuth2Client's settings.