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

OidcProvider

Typed authentication capabilities for one configured OpenID Connect provider.

Exposes verified protocol-native authentication schemes with precise OidcToken principal types. Map those schemes to application principals with io.ktor.server.auth.mapPrincipal.

jwtBearer is available when the provider was configured with bearer { }. introspectionBearer is available when nested bearer { introspection { } } is configured. session is available when the provider was configured with oauth { } and sessions were not disabled.

Report a problem

Properties

introspectionBearer

val introspectionBearer: SimpleAuthenticationScheme<OidcToken.Introspected>

Introspection Bearer authentication scheme.

issuer

val issuer: String

Configured issuer identifier URL for this provider.

jwtBearer

val jwtBearer: SimpleAuthenticationScheme<OidcToken.Access>

JWT Bearer authentication scheme.

name

val name: String

provider name. It is also used to derive default routes (/oidc/{name}/...), the OAuth scheme name ({name}-oauth), Bearer scheme names ({name}-jwt-bearer, {name}-introspection-bearer), and the default session cookie root ({NAME}_SESSION).

session

val session: SessionAuthenticationScheme<OidcToken.Id, OidcToken.Id>

Typed browser session authentication scheme.

Functions

currentJwkProvider

fun currentJwkProvider(): JwkProvider

Returns the currently active JWK provider for this provider. The returned value can change after a successful periodic discovery refresh when the discovery document points to a different JWKS URI.

currentMetadata

fun currentMetadata(): OpenIdProviderMetadata

Returns the currently active OpenID Connect discovery metadata for this provider. The returned value can change after a successful periodic discovery refresh.

refreshToken

suspend fun refreshToken(refreshToken: String): OidcTokenRefreshResult

Refreshes token material for this provider using the supplied refresh token.