ktor-server-auth/io.ktor.server.auth/principal

principal

inline fun <P : Any> ApplicationCall.principal(): P?(source)

Retrieves an authenticated principal Any for this call.

Report a problem

inline fun <P : Any> ApplicationCall.principal(provider: String?): P?(source)

Retrieves an authenticated principal Any for this call from provider with name provider

Report a problem

@ExperimentalKtorApi

context(authCtx: PrincipalContext<P>)
val <P : Any> ApplicationCall.principal: P(source)

Authenticated principal captured for the current typed route.

The property is available inside route handlers nested in authenticateWith and is typed by the scheme used to protect the route. Unlike ApplicationCall.principal, it does not require an explicit type argument and is only available inside typed authentication route blocks.

Use ApplicationCall.principal outside typed routes.

Report a problem