oauth2/com.okta.oauth2/AuthorizationCodeFlow

AuthorizationCodeFlow

class ~~AuthorizationCodeFlow~~(client: OAuth2Client)

Deprecated

The Android-only AuthorizationCodeFlow is deprecated in favor of the KMP variant, which works on Android and JVM. Use com.okta.oauth2.kmp.AuthorizationCodeFlow instead, or the higher-level com.okta.webauthenticationui.WebAuthentication which is already KMP-backed. This class will be removed in a future major release.

AuthorizationCodeFlow encapsulates the behavior required to authentication using an OIDC Browser redirect flow.

See Authorization Code Flow documentation

Constructors

AuthorizationCodeFlow

constructor(client: OAuth2Client)

constructor()

Initializes an authorization code flow.

constructor(oidcConfiguration: OidcConfiguration)

Initializes an authorization code flow using the OidcConfiguration.

Types

Companion

object Companion

Context

class Context

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

MissingResultCodeException

class MissingResultCodeException : Exception

Used in a OAuth2ClientResult.Error.exception from resume.

RedirectSchemeMismatchException

class RedirectSchemeMismatchException : Exception

Used in a OAuth2ClientResult.Error.exception from resume.

ResumeException

class ResumeException : Exception

Used in a OAuth2ClientResult.Error.exception from resume.

Functions

resume

suspend fun resume(uri: Uri, flowContext: AuthorizationCodeFlow.Context): OAuth2ClientResult<Token>

Resumes the OIDC Authorization Code redirect flow. This method takes the returned redirect Uri, and communicates with the Authorization Server to exchange that for a token.

start

suspend fun ~~start~~(redirectUrl: String, extraRequestParameters: Map<String, String> = emptyMap(), scope: String = client.configuration.defaultScope, state: String = UUID.randomUUID().toString()): OAuth2ClientResult<AuthorizationCodeFlow.Context>

suspend fun start(redirectUrl: String, extraRequestParameters: Map<String, String> = emptyMap(), scope: List<String>, state: String = UUID.randomUUID().toString()): OAuth2ClientResult<AuthorizationCodeFlow.Context>

Initiates the OIDC Authorization Code redirect flow.