Class RbacAuthGuard

Custom RBAC (Role-Based Access Control) AuthGuard that extends the JwtAuthGuard. This guard checks if the authenticated user has the required roles and permissions to access a specific route.

Hierarchy

  • IAuthGuard
    • RbacAuthGuard

Constructors

  • Creates an instance of RbacAuthGuard.

    Parameters

    • rbacService: SecureRbacService

      The RBAC service to check user roles and permissions.

    • reflector: Reflector

      The NestJS reflector used to get metadata from the route handlers.

    Returns RbacAuthGuard

Properties

rbacService: SecureRbacService

The RBAC service to check user roles and permissions.

reflector: Reflector

The NestJS reflector used to get metadata from the route handlers.

arguments: any
caller: Function
length: number
name: string

Returns the name of the function. Function names are read-only and can not be changed.

Methods

  • Method that checks if the authenticated user has the required roles and permissions to access a specific route. Overrides the canActivate method of the parent class.

    Parameters

    • context: ExecutionContext

      The execution context containing the request and response objects.

    Returns Promise<boolean>

    A boolean indicating whether the user is authorized to access the route or not.

    Async

    Method

    Throws

    If the user does not have the required roles or permissions.

  • Parameters

    • context: ExecutionContext

    Returns IAuthModuleOptions<any>

  • Type Parameters

    • T = any

    Parameters

    • context: ExecutionContext

    Returns T

  • Type Parameters

    • TUser = any

    Parameters

    • err: any
    • user: any
    • info: any
    • context: ExecutionContext
    • Optional status: any

    Returns TUser

  • Type Parameters

    • TRequest extends {
          logIn: Function;
      } = any

    Parameters

    • request: TRequest

    Returns Promise<void>

  • Determines whether the given value inherits from this function if this function was used as a constructor function.

    A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

    Parameters

    • value: any

    Returns boolean

  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • this: Function
    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

  • Returns a string representation of a function.

    Returns string

Generated using TypeDoc