oauth2/com.okta.oauth2/RedirectEndSessionFlow

RedirectEndSessionFlow

class ~~RedirectEndSessionFlow~~(client: OAuth2Client)

Deprecated

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

RedirectEndSessionFlow encapsulates the behavior required to logout using an OIDC Browser redirect flow.

Note: OIDC Logout terminology is nuanced, see Logout Documentation for additional details.

Constructors

RedirectEndSessionFlow

constructor(client: OAuth2Client)

constructor()

Initializes an end session redirect flow.

constructor(oidcConfiguration: OidcConfiguration)

Initializes an end session redirect flow using OidcConfiguration.

Types

object Companion

A model representing the context and current state for a logout flow.

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

fun resume(uri: Uri, flowContext: RedirectEndSessionFlow.Context): OAuth2ClientResult<Unit>

Resumes the logout redirect flow.

suspend fun start(redirectUrl: String, idToken: String): OAuth2ClientResult<RedirectEndSessionFlow.Context>

Initiates the logout redirect flow.