WebAuthenticationClient

class WebAuthenticationClient

Authentication coordinator that simplifies signing users in using browser-based OIDC authentication flows.

This simple class encapsulates the details of launching the browser, and coordinating with OAuth2 endpoints.

To customize the flow, please read more about customization options: WebAuthenticationProvider, CustomizeBrowserEvent, CustomizeCustomTabsEvent. To further customize the authentication flow, please read more about the underlying flows: AuthorizationCodeFlow, RedirectEndSessionFlow.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
class FlowCancelledException : Exception

Functions

Link copied to clipboard
suspend fun login(    context: Context,     redirectUrl: String,     extraRequestParameters: Map<String, String> = emptyMap(),     scope: String = oidcClient.configuration.defaultScope): OidcClientResult<Token>

Initiates the OIDC Authorization Code redirect flow.

Link copied to clipboard
suspend fun logoutOfBrowser(    context: Context,     redirectUrl: String,     idToken: String): OidcClientResult<Unit>

Initiates the OIDC logout redirect flow.