NestJS 结合 Keycloak 管理员接口的最佳实践-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00060/article/details/147447201

NestJS 结合 Keycloak 管理员接口的最佳实践

nestjs-keycloak-admin Keycloak client and admin provider for Nest.js applications with built-in User Managed Access (UMA) and ACL support. 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-keycloak-admin

1. 项目介绍

本项目是基于 NestJS 框架和 Keycloak 管理员接口构建的一个开源项目。它提供了对 Keycloak 管理员接口的封装，使得开发者可以更加便捷地在 NestJS 应用中集成 Keycloak 的用户和角色管理功能。

2. 项目快速启动

环境准备

Node.js (推荐使用 LTS 版本)
npm 或 yarn

克隆项目

git clone https://github.com/anonrig/nestjs-keycloak-admin.git
cd nestjs-keycloak-admin

安装依赖

npm install
# 或者
yarn install

配置 Keycloak

在 src/config/keycloak.config.ts 文件中配置 Keycloak 的连接信息：

export default {
  keycloak: {
    baseUrl: 'http://your-keycloak-url',
    realm: 'your-realm',
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret',
  },
};

运行项目

npm run start
# 或者
yarn start

3. 应用案例和最佳实践

集成 Keycloak 管理员接口

在您的 NestJS 应用中，可以通过注入 KeycloakAdminService 来使用 Keycloak 管理员接口：

import { Controller } from '@nestjs/common';
import { KeycloakAdminService } from 'nestjs-keycloak-admin';

@Controller('users')
export class UsersController {
  constructor(private readonly keycloakAdminService: KeycloakAdminService) {}

  async getUsers() {
    return this.keycloakAdminService.users.list();
  }
}

用户管理

您可以轻松地添加、更新、删除用户，以及查询用户信息：

const userRepresentation = {
  username: 'john-doe',
  email: 'john@example.com',
  // 其他用户信息
};

// 添加用户
await this.keycloakAdminService.users.create(userRepresentation);

// 更新用户
await this.keycloakAdminService.users.update(userId, userRepresentation);

// 删除用户
await this.keycloakAdminService.users.delete(userId);

// 获取用户信息
const user = await this.keycloakAdminService.users.findOne(userId);

角色和权限管理

管理用户角色和权限也是 Keycloak 的强项，本项目使得这些操作变得简单：

// 给用户添加角色
await this.keycloakAdminService.users.addRoleToUser(userId, roleId);

// 删除用户角色
await this.keycloakAdminService.users.removeRoleFromUser(userId, roleId);