npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nest-keycloak-user-manager

v1.0.1

Published

The `nest-keycloak-user-manager` package provides an easy way to manage users with Keycloak in a NestJS application. It offers pre-built endpoints for common user management tasks while allowing customization for your own endpoints if needed.

Downloads

8

Readme

Keycloak User Manager

The nest-keycloak-user-manager package provides an easy way to manage users with Keycloak in a NestJS application. It offers pre-built endpoints for common user management tasks while allowing customization for your own endpoints if needed.

Features

  • Easy integration with Keycloak
  • Pre-built user management endpoints
  • Configurable module for different Keycloak instances
  • Extendable service for custom user management logic

Description

Module/Boilerplate for simplified user-management w/ Keycloak in NestJS applications

Installation

To install the package, use npm or yarn:

npm install nest-keycloak-user-manager
# or
yarn add nest-keycloak-user-manager

Configuration

To configure the module, you need to provide the Keycloak connection details in your app.module.ts file:

import { Module } from '@nestjs/common';
import { KeycloakUserManagerModule } from 'nest-keycloak-user-manager';

@Module({
  imports: [
    KeycloakUserManagerModule.register({
      baseUrl: 'http://localhost:8080',
      realm: 'med5-realm',
      clientId: 'med5-clientId',
      clientSecret: 'med5-clientSecret',

    }),
  ],
})
@Global()
export class AppModule {}

Usage

Pre-built Endpoints

Once the module is configured, you can use the following endpoints to manage users:

  • GET /users: Returns a list of all users in the Keycloak realm.
  • GET /users/:id: Returns the user with the specified ID.
  • POST /users: Creates a new user in the Keycloak realm.
  • PUT /users/:id: Updates the user with the specified ID.
  • DELETE /users/:id: Deletes the user with the specified ID.
  • PUT /users/reset-password: Resets the password of a user.

You should respect the following shape of the user object:

{
  username: string;
  email: string;
  firstName: string;
  lastName: string;  
}
// for resetting the password, the body should be:
{
  id: string;
  password: string;
}

Custom Endpoints

If you need to create your own endpoints, you can use the KeycloakUserManagerService provided by the module. Following is an example of how to use it:

import { Controller, Post, Body, Put, Param, Get, Delete } from '@nestjs/common';
import { KeycloakUserManagerService } from 'nest-keycloak-user-manager';
import { AddUserDto, UpdateUserDto } from 'src/dto/custom-users.dto'; // your custom dto

@Controller('custom-users')
export class UserService {
  constructor(private readonly keycloakUserManagerService: KeycloakUserManagerService) {}
  
  @Post()
  async addUser(@Body() addUserDto: AddUserDto){
    return await this.keycloakUserManagerService.createUser(addUserDto);
  }

  @Put(':id')
  async modifyUser(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto){
    return await this.keycloakUserManagerService.updateUser(id, updateUserDto);
  }

  @Get(':id')
  async getOneUser(@Param('id') id: string){
    return await this.keycloakUserManagerService.findUserById(id);
  }

  @Get()
  async getAllUsers(){
    return await this.keycloakUserManagerService.findManyUsers();
  }
  @Delete(':id')
  async removeUser(@Param('id') id: string){
    return await this.keycloakUserManagerService.deleteUser(id);
  }

}

Contributing

Contributions are welcome! Feel free to do contribute by opening issues and/or pull requests.

Stay in touch

  • Author - [Mohamed Lamine Badji] (https://flowcv.me/muhammad-al-amine)
  • Twitter - @Med5Lemzi