ktor-server-auth/io.ktor.server.auth/authenticateWithAnyOf

authenticateWithAnyOf

inline fun <P : Any> Route.authenticateWithAnyOf(vararg schemes: AuthenticationScheme<out P, *>, onUnauthorized: MultiUnauthorizedHandler? = null, noinline build: context(PrincipalContext<P>) Route.() -> Unit): Route(source)

Creates a child route that accepts any of the provided typed authentication schemes.

The first scheme that authenticates the call supplies principal inside build. All schemes must produce principals assignable to P. Session schemes may be included, but the route context is always PrincipalContext. Only principal is available inside build; scheme-specific context extensions such as session are not exposed. Each provider is registered lazily on first use and reused on later uses. A different provider with an already registered name is rejected.

authenticateWithAnyOf(apiKeyAuth, bearerAuth) {
    get("/api/me") {
        call.respondText(call.principal.id)
    }
}

Report a problem

Parameters

schemes

typed schemes accepted by this route.

onUnauthorized

optional handler invoked when all schemes fail. When omitted, the first scheme-level AuthenticationScheme.onUnauthorized handler is used before default challenges are executed.

build

route builder with PrincipalContext available as a context parameter.