@cifra-x/nest-keycloak
v1.1.1
Published
keycloak-nodejs-connect module for Nest
Downloads
972
Readme
Nest Keycloak Adapter
NestJS 11 module adapter of the keycloak-nodejs-connect library
Decorators
| Decorator | Description |
|:---------------------|:------------------------------------------------------------------------------------------------------------------------|
| @AuthenticatedUser | Retrieves the current Keycloak logged-in user. (Must be applied per method, unless the controller is request-scoped.) |
| @Public | Allows any user to access the route (bypasses authentication). |
| @Resource | Specifies the Keycloak application resource name. |
| @Scopes | Specifies the Keycloak application scope name. |
| @Roles | Specifies the Keycloak realm or application roles. |
Nest Keycloak Options
| Option | Description | Required | Default |
|:--------------------|:--------------------------------------------------------------------------|:--------:|:--------------:|
| cookieKey | Cookie key name. | No | KEYCLOAK_JWT |
| logLevels | NestJS logger level. | No | log |
| policyEnforcement | Sets the policy enforcement mode. | No | PERMISSIVE |
| tokenValidation | Sets the token validation method. | No | ONLINE |
Установка
Для установки запустить команду npm install
Сборка
Для билда запустить команду npm run build
Создание новой версии
Для выпуска новой версии выполнить команду npm version [patch|minor|major]
Установка пакета
npm i @cifra-x/nest-keycloak