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

OidcProviderConfig

Configuration for a single OpenID Connect provider (issuer).

The provider shares discovery, JWT, Bearer, and OAuth configuration. Route-facing schemes expose precise OidcToken subtypes on OidcProvider. Map those schemes to application principals with io.ktor.server.auth.mapPrincipal.

Report a problem

Properties

issuer

lateinit var issuer: String

Issuer URL. Used for OpenID Connect discovery (<issuer>/.well-known/openid-configuration) unless metadata is configured.

metadata

var metadata: OpenIdProviderMetadata?

Static OpenID Provider metadata for this provider.

name

val name: String

provider name used for generated routes and authentication scheme names.

tokenRefreshCacheMaxSize

var tokenRefreshCacheMaxSize: Int

Maximum number of in-flight or recently completed OidcProvider.refreshToken entries retained for this provider.

tokenRefreshCacheTtl

var tokenRefreshCacheTtl: Duration

How long a completed OidcProvider.refreshToken result stays available so concurrent callers with the same refresh token reuse it.

Functions

bearer

fun bearer(configure: OidcBearerConfig.() -> Unit = {})

Enables resource-server Bearer authentication for this provider.

jwt

fun jwt(keys: OpenIdTestKeys)

Configures JWT verification for tests using OpenIdTestKeys.

fun jwt(configure: OidcJwtConfig.() -> Unit)

Configures JWT verification shared by ID-token and JWT access-token validation.

oauth

fun oauth(configure: OidcOAuthConfig.() -> Unit)

Configures the OAuth/OpenID Connect login flow for this provider.