interface AuthPluginOptions
Since 0.1.0

Auth plugin configuration options.

Properties

readonly
jwt: JwtOptions

JWT configuration. Required.

readonly
optional
apiKey: ApiKeyOptions

API key configuration. Optional.

readonly
optional
local: LocalOptions

Local credentials configuration. Optional.

readonly
optional
rbac: RbacConfig

RBAC configuration. When absent, AuthPlugin registers JWT authentication only and does not provide the authorization capability.

readonly
optional
session: SessionAuthOptions

Session authentication configuration. When present, the plugin appends an internal session strategy after the API-key strategy and requires the session capability (SessionPlugin) to be registered.

readonly
optional
strategies: readonly IAuthStrategy[]

Caller-supplied strategies, appended after every built-in in declaration order. A strategy whose name collides with any other strategy in the assembled chain makes register() throw.

Usage

import { type AuthPluginOptions } from "auth-plugin/src/index.ts";