Skip to content

amsametech/kinde-auth-nestjs

Repository files navigation

Nest Logo

Kinde Auth NestJs

A NestJs Module to validate your Kinde JSON Web Tokens

node-current MIT License npm version

Usage

If you are using a mobile or front-end Kinde SDK and want to protect your NestJs back-end APIs, this Module is relevant for you.

  • Install the module

npm i @amsame/kinde-auth-nestjs
  • Set the environments

    To run this module, you will need to set only one environment variable
KINDE_DOMAIN_URL=https://<your-subdomain>.kinde.com
  • Load the module

import { Module } from '@nestjs/common';
import { KindeModule } from '@amsame/kinde-auth-nestjs';

@Module({
  imports: [..., ..., KindeModule],
  controllers: [...],
  providers: [...],
})
export class AppModule {}
  • Protect your endpoints

import { Controller, Get } from '@nestjs/common';
import { KindeIsAuth } from '@amsame/kinde-auth-nestjs';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  @KindeIsAuth()
  hello() {
      ...
  }
}
import { Controller, Get } from '@nestjs/common';
import { KindeRoles } from '@amsame/kinde-auth-nestjs';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  @KindeRoles(['ADMIN'])
  hello() {
      ...
  }
}
  • Protect by permissions

    🔴 IMPORTANT you must enable hasura headers
import { Controller, Get } from '@nestjs/common';
import { KindePermissions } from '@amsame/kinde-auth-nestjs';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  @KindePermissions(['YOUR_PERMISSION_HERE', '...'])
  hello() {
      ...
  }
}
  • Get user details

import { Controller, Get } from '@nestjs/common';
import { IKindeUser, KindeIsAuth, KindeUser } from '@amsame/kinde-auth-nestjs';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  hello(@KindeUser() user: IKindeUser) {
    console.log(user)
      ...
  }
}
  • Graphql Resolver

  @Query(() => Post)
  async findPostById(
    @Args('id', { type: () => Int }) id: number,
    @KindeUser() user: IKindeUser,
  ) {
    console.log(id, user);
    return ...;
  }

kinde supports multi-domain authentication where the primary domain is the same, but there are different NestJs services running in different subdomains. For example. service1.yourdomain.com, service2.yourdomain.com, so make sure to set this environment in your kinde SDK

KINDE_COOKIE_DOMAIN=.yourdomain.com

License

MIT