@xprb/keycloak-operations-manager v1.3.2

keycloak-operations-manager

Installation

$ yarn install @xprb/keycloak-operations-manager

Quick start

import KeycloakOperationsManagerModule into the root AppModule and use the forRootAsync() method to configure it.

    KeycloakOperationsManagerModule.forRootAsync({
      inject: [ConfigService],
      useFactory: (configService: ConfigService) => ({
        baseUrl: configService.get<string>(`keycloakUrl`),
        clientId: configService.get<string>('clientId'),
        clientSecret: configService.get<string>('clientSecret'),
      }),
    }),

Afterward, the Keycloak Operations Manager instance will be available to inject across entire project

import { MFA } from '@xprb/keycloak-operations-manager';
@Injectable()
export class DummyService {
  constructor(private readonly mfa: MFA) {}
}

Available Injectable Modules

| Module Name
| :-----------------------------
| Auth
| MFA
| Permission

Auth Guard

You can write own auth guard or you can use default one.

import {  Module } from '@nestjs/common';
import { ConfigService, ConfigModule as NestConfigModule } from '@nestjs/config';
import { APP_GUARD } from '@nestjs/core';
import { ClsModule } from 'nestjs-cls';
import {  REQUEST_ID_HEADER_KEY } from './common';
import { KeycloakOperationsManagerModule, AuthGuard } from '@xprb/keycloak-operations-manager';
import { JwtModule } from '@nestjs/jwt';

@Module({
  imports: [
    KeycloakOperationsManagerModule.forRootAsync({
      inject: [ConfigService],
      useFactory: (configService: ConfigService) => ({
        baseUrl: configService.get<string>(`microserviceConfig.urls.auth`),
        clientId: configService.get<string>('keycloakConfig.username'),
        clientSecret: configService.get<string>('keycloakConfig.password'),
      }),
    }),
    ClsModule.forRoot({
      global: true,
      middleware: {
        mount: true,
        generateId: true,
        idGenerator: (req: Request) => req.headers[REQUEST_ID_HEADER_KEY],
      },
    }),
    JwtModule
  ],
  controllers: [AppController],
  providers: [
    {
      provide: APP_GUARD,
      useClass: AuthGuard,
    }
  ],
})
export class AppModule  {}