ktor-server-auth-oidc/io.ktor.server.auth.oidc/OidcSessionsConfig

OidcSessionsConfig

Configuration for OIDC session transport and CSRF protection.

Controls how the OpenID Connect session is stored and transported between client and server, and whether CSRF protection is applied to routes authenticated with the enclosing provider.

By default, sessions use cookie transport with secure defaults and CSRF protection is enabled with CSRFConfig.originMatchesHost.

Configure via OidcOAuthConfig.sessions.

Report a problem

Properties

name

var name: String?

Cookie / session name.

storage

var storage: SessionStorage

Server-side session storage. Defaults to in-memory storage.

tokenRefreshStrategy

var tokenRefreshStrategy: OidcTokenRefreshStrategy

Strategy used to refresh session token.

Functions

fun cookie(configure: CookieIdSessionBuilder<OidcToken.Id>.() -> Unit)

Configures cookie attributes for the session cookie.

csrfProtection

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

Configures CSRF protection for routes authenticated with this provider's typed session capability.

disableCsrfProtection

fun disableCsrfProtection()

Disables CSRF protection for this provider's routes.