ktor-server-auth/io.ktor.server.auth/OAuth2SessionsConfig

OAuth2SessionsConfig

open class OAuth2SessionsConfig<S : Any, P : Any> : TypedSessionAuthConfig<S, P> (source)

Configures session storage and principal resolution for an OAuth2SessionFlow.

The OAuth callback authenticates the token exchange. sessionCreator maps the OAuth response to the stored session value S, and validate maps that session to the route principal P. Both are required.

Protected routes use the challenge strategy from TypedSessionAuthConfig.

Report a problem

Type Parameters

the session type stored by the Sessions plugin.

the principal type available in protected route handlers.

Properties

description

var description: String?

Human-readable description of this authentication scheme.

name

var name: String?

Session provider name used by the Sessions plugin.

onUnauthorized

var onUnauthorized: UnauthorizedHandler?

Default handler for authentication failures.

sessionCreator

var sessionCreator: suspend RoutingContext.(OAuthAccessTokenResponse.OAuth2) -> S??

Maps a successful OAuth response to the session value stored by the Sessions plugin.

transport

var transport: SessionTransportType<S>

Configures how the typed session scheme installs the Sessions plugin.

Functions

csrfProtection

fun csrfProtection(config: CSRFConfig.() -> Unit)

Configures CSRF protection for routes authenticated with this session scheme.

transformSession

fun transformSession(block: SessionTransformer<S>)

Transforms the session value before validate resolves the route principal.

validate

fun validate(body: SessionPrincipalResolver<S, P>?)

Sets a validation function for the session value.