OAuthSessionFlowConfig

Configures a typed OAuth 2.0 flow with session-backed route authentication.

Used by oauth2Session to combine OAuthFlowConfigBase with session storage, session creation, and principal resolution via sessions.

Report a problem

Type Parameters

S

the session type stored by the Sessions plugin.

P

the principal type available in protected route handlers.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

HTTP client used to call the OAuth token endpoint.

Link copied to clipboard

A description of the provider that can be used for API documentation.

Link copied to clipboard

A required route path that starts the OAuth redirect when visited.

Link copied to clipboard

Handles OAuth 2.0 errors such as authorization errors and token exchange failures.

Link copied to clipboard

Resolves OAuth 2.0 server settings for the current routing context.

Link copied to clipboard

Session configuration set by sessions.

Link copied to clipboard

Static OAuth 2.0 server settings. Either this or providerLookup must be specified.

Functions

Link copied to clipboard

Configures the OAuth callback route and success handler for a session-backed flow.

Link copied to clipboard
fun sessions(configure: OAuth2SessionsConfig<S, P>.() -> Unit)

Configures session storage, session creation, and principal resolution for this OAuth session flow.