Role-based authorization in NestJS

Introduction

Role-based authorization helps control who can do what in your app. It keeps things safe by letting only certain users access specific parts.

When you want to allow only admins to delete data.

When you want regular users to view content but not edit it.

When different user roles have different access levels in your app.

When you want to protect sensitive routes based on user roles.

Syntax

NestJS

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Reflector } from '@nestjs/core';

@Injectable()
export class RolesGuard implements CanActivate {
  constructor(private reflector: Reflector) {}

  canActivate(context: ExecutionContext): boolean {
    const requiredRoles = this.reflector.getAllAndOverride<string[]>('roles', [
      context.getHandler(),
      context.getClass(),
    ]);
    if (!requiredRoles) {
      return true;
    }
    const { user } = context.switchToHttp().getRequest();
    return requiredRoles.some(role => user.roles?.includes(role));
  }
}

The RolesGuard checks if the user has the needed roles to access a route.

Use @SetMetadata('roles', ['roleName']) on controllers or routes to specify roles.

Examples

This helper decorator sets roles metadata on routes or controllers.

NestJS

import { SetMetadata } from '@nestjs/common';

export const Roles = (...roles: string[]) => SetMetadata('roles', roles);

This route can only be accessed by users with the 'admin' role.

NestJS

@Roles('admin')
@Get('admin-data')
getAdminData() {
  return 'Secret admin data';
}

The guard protects the controller, and the route allows users with 'user' or 'admin' roles.

NestJS

@UseGuards(RolesGuard)
@Controller('users')
export class UsersController {
  @Roles('user', 'admin')
  @Get('profile')
  getProfile() {
    return 'User profile data';
  }
}

Sample Program

This example shows a controller with two routes. One route is only for admins, the other for users or admins. The RolesGuard checks the user's roles before allowing access.

NestJS

import { Controller, Get, UseGuards } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { Injectable, CanActivate, ExecutionContext, SetMetadata } from '@nestjs/common';

export const Roles = (...roles: string[]) => SetMetadata('roles', roles);

@Injectable()
export class RolesGuard implements CanActivate {
  constructor(private reflector: Reflector) {}

  canActivate(context: ExecutionContext): boolean {
    const requiredRoles = this.reflector.getAllAndOverride<string[]>('roles', [
      context.getHandler(),
      context.getClass(),
    ]);
    if (!requiredRoles) {
      return true;
    }
    const { user } = context.switchToHttp().getRequest();
    return requiredRoles.some(role => user.roles?.includes(role));
  }
}

@UseGuards(RolesGuard)
@Controller('dashboard')
export class DashboardController {
  @Roles('admin')
  @Get('admin')
  getAdminDashboard() {
    return 'Welcome to the admin dashboard';
  }

  @Roles('user', 'admin')
  @Get('user')
  getUserDashboard() {
    return 'Welcome to the user dashboard';
  }
}

Important Notes

Make sure your authentication system adds a user object with roles to the request.

Roles are usually strings like 'admin', 'user', or 'editor'.

Use @UseGuards(RolesGuard) to activate role checks on controllers or routes.

Summary

Role-based authorization controls access by user roles.

Use decorators to mark which roles can access routes.

Use a guard to check roles before allowing access.

Practice

1. What is the main purpose of role-based authorization in a NestJS application?

easy

A. To handle HTTP request parsing

B. To manage database connections

C. To control access to routes based on user roles

D. To format response data

Solution

1. Step 1: Understand role-based authorization concept

   Role-based authorization restricts access to parts of an app depending on the user's role.

2. Step 2: Identify the purpose in NestJS context

   In NestJS, it controls which users can access certain routes or features based on their roles.

3. Final Answer:

   To control access to routes based on user roles -> Option C

4. Quick Check:

   Role-based authorization = Access control by roles [OK]

Hint: Remember: roles decide who can access what [OK]

Common Mistakes:

• Confusing authorization with authentication
• Thinking it manages database or HTTP parsing
• Mixing up roles with user data formatting

2. Which decorator is commonly used in NestJS to specify roles allowed on a route?

easy

A. @Roles()

B. @UseGuards()

C. @Controller()

D. @Get()

Solution

1. Step 1: Identify role-specifying decorators

   In NestJS, @Roles() decorator marks which roles can access a route.

2. Step 2: Differentiate from other decorators

   @UseGuards() applies guards, @Controller() defines controllers, @Get() defines HTTP GET routes.

3. Final Answer:

   @Roles() -> Option A

4. Quick Check:

   @Roles() sets allowed roles [OK]

Hint: Look for decorator naming roles directly [OK]

Common Mistakes:

• Using @UseGuards() to specify roles directly
• Confusing route decorators with role decorators
• Missing that @Roles() is custom, not built-in

3. Given this code snippet, what will happen when a user with role 'user' accesses the route?

@Roles('admin')
@Get('admin-data')
getAdminData() {
  return 'Secret admin data';
}

medium

A. The user will receive 'Secret admin data'

B. The user will get a 403 Forbidden error

C. The route will return undefined

D. The server will crash with an error

Solution

1. Step 1: Check the role required by the route

   The route requires 'admin' role via @Roles('admin').

2. Step 2: Compare with user's role

   User has role 'user', which does not match 'admin'.

3. Final Answer:

   The user will get a 403 Forbidden error -> Option B

4. Quick Check:

   Role mismatch causes 403 Forbidden [OK]

Hint: If user role ≠ required role, access denied [OK]

Common Mistakes:

• Assuming any role can access
• Thinking route returns undefined on denial
• Expecting server crash on role mismatch

4. Identify the error in this NestJS guard code for role checking:

canActivate(context: ExecutionContext): boolean {
  const request = context.switchToHttp().getRequest();
  const user = request.user;
  const roles = this.reflector.get('roles', context.getHandler());
  if (!roles) {
    return true;
  }
  return roles.includes(user.role);
}

medium

A. Missing async keyword on canActivate

B. Returning true when roles are not defined

C. Using getHandler() instead of getClass() for roles

D. Not checking if user exists before accessing user.role

Solution

1. Step 1: Review user role access

   The code accesses user.role without verifying if user is defined.

2. Step 2: Identify potential runtime error

   If user is undefined, accessing user.role causes an error.

3. Final Answer:

   Not checking if user exists before accessing user.role -> Option D

4. Quick Check:

   Always check user before role access [OK]

Hint: Check user object exists before role check [OK]

Common Mistakes:

• Assuming user is always present
• Confusing getHandler() and getClass() usage
• Thinking async is required for synchronous guard

5. How can you combine role-based authorization with route-level guards to allow access only if the user has either 'admin' or 'manager' role in NestJS?

hard

A. Use @Roles('admin', 'manager') decorator and a RolesGuard that checks for any matching role

B. Use two separate @Roles decorators, one for 'admin' and one for 'manager', on the same route

C. Use @UseGuards(AdminGuard, ManagerGuard) without @Roles decorator

D. Check roles manually inside the controller method without decorators or guards

Solution

1. Step 1: Understand role decorator usage

   @Roles() accepts multiple roles to allow any of them access.

2. Step 2: Use a guard that checks if user role matches any allowed role

   The RolesGuard reads roles from metadata and checks if user role is included.

3. Final Answer:

   Use @Roles('admin', 'manager') decorator and a RolesGuard that checks for any matching role -> Option A

4. Quick Check:

   Multiple roles in @Roles() + guard = flexible access [OK]

Hint: Pass multiple roles in one @Roles() decorator [OK]

Common Mistakes:

• Using multiple @Roles decorators on one route
• Applying multiple guards instead of one flexible guard
• Skipping decorators and guards for manual checks