Class GraphQLPermissionsGuard

Guard that checks if user has permission to access resource

Example: - Use in resolver

@UseGuards(GraphQLJwtAuthGuard, GraphQLPermissionsGuard)
@UsePermissions('js:core:users:get')
@Resolver(() => User)
export class UserResolver {
 // ...
}

Example: - Use for queries

@UseGuards(GraphQLJwtAuthGuard, GraphQLPermissionsGuard)
@UsePermissions('js:core:users:get')
@Query(() => User)
async user(
 @Args('id') id: string
) {
 // ...
}

Example: - Use for mutation

@UseGuards(GraphQLJwtAuthGuard, GraphQLPermissionsGuard)
@UsePermissions('js:core:users:delete')
@Mutation(() => Boolean)
async deleteUser(
 @Args('id') id: string
) {
 // ...
}

Hierarchy (View Summary)

Constructors

constructor

Methods

canActivate getRequest getRequestDetails getUserFromContext

Constructors

constructor

Methods

canActivate

  • canActivate(context: ExecutionContext): Promise<boolean>

    Parameters

    • context: ExecutionContext

      execution context

    Returns Promise<boolean>

    • true if user has permission to access resource

    Throws

    • AccessDeniedException if user has no permission to access resource

    Example: - Use in resolver

    @UseGuards(GraphQLJwtAuthGuard, GraphQLPermissionsGuard)
    @UsePermissions('js:core:users:get')

getRequest

  • getRequest(
        context: ExecutionContext,
    ): Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> & {
        user?: BaseUser;
    }

    Get request from GraphQL execution context

    Parameters

    • context: ExecutionContext

      execution context

    Returns Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> & {
        user?: BaseUser;
    }

    request from GraphQL execution context

getRequestDetails

  • getRequestDetails(context: ExecutionContext): Record<string, unknown>

    Extracts request details from execution context

    Parameters

    • context: ExecutionContext

      execution context

    Returns Record<string, unknown>

    request details

getUserFromContext

  • getUserFromContext(context: ExecutionContext): null | BaseUser

    Extracts current user from GraphQL context

    Parameters

    • context: ExecutionContext

      execution context

    Returns null | BaseUser

    current user if exists

Settings

Member Visibility

On This Page

Constructors
Methods