okta-idx-kotlin/com.okta.idx.kotlin.client/InteractionCodeFlow

InteractionCodeFlow

class InteractionCodeFlow(val client: OAuth2Client)

The InteractionCodeFlow class is used to define and initiate an authentication workflow utilizing the Okta Identity Engine.

Constructors

Link copied to clipboard
constructor()

Initializes a new InteractionCodeFlow.

constructor(oidcConfiguration: OidcConfiguration)

Initializes a new InteractionCodeFlow.

constructor(client: OAuth2Client)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Functions

Link copied to clipboard
suspend fun evaluateRedirectUri(uri: Uri): IdxRedirectResult

Evaluates the given redirect url to determine what next steps can be performed. This is usually used when receiving a redirection from an IDP authentication flow.

Link copied to clipboard
suspend fun exchangeInteractionCodeForTokens(remediation: IdxRemediation): OAuth2ClientResult<Token>

Exchange the IdxRemediation.Type.ISSUE remediation type for tokens.

Link copied to clipboard
suspend fun proceed(remediation: IdxRemediation): OAuth2ClientResult<IdxResponse>

Executes the remediation option and proceeds through the workflow using the supplied form parameters.

Link copied to clipboard
suspend fun resume(): OAuth2ClientResult<IdxResponse>

Resumes the authentication state to identify the available remediation steps.

Link copied to clipboard
suspend fun start(redirectUri: Uri, extraStartRequestParameters: Map<String, String> = emptyMap()): OAuth2ClientResult<Unit>

Starts the authentication session. Returns an empty OAuth2ClientResult.Success on success, and a OAuth2ClientResult.Error with the corresponding exception on failure.