Interface IBaseActionContext

GraphQL base action context Used for mutations and queries

interface IBaseActionContext {
    requestId: string;
    user: CurrentUser;
    isGranted(
        action: string,
        actionScopes?: ActionScopes | ActionScopesArray,
    ): boolean;
    validateAccess(
        action: string,
        scopes?: ActionScopes | ActionScopesArray,
    ): void;
}

Properties

requestId user

Methods

isGranted validateAccess

Properties

requestId

requestId: string

Request ID Used for logging to track request

user

user: CurrentUser

Current user who executes action

Methods

isGranted

  • isGranted(
        action: string,
        actionScopes?: ActionScopes | ActionScopesArray,
    ): boolean

    Check if current user from context has permission

    Parameters

    • action: string

      action string

    • OptionalactionScopes: ActionScopes | ActionScopesArray

      scopes where action was executed

    Returns boolean

validateAccess

  • validateAccess(action: string, scopes?: ActionScopes | ActionScopesArray): void

    Check permission and throw AccessDenied error if user doesn't have permission

    Parameters

    • action: string

      action string

    • Optionalscopes: ActionScopes | ActionScopesArray

      scopes where action was executed

    Returns void

    Throws

    AccessDenied error if the user doesn't have the permission

Settings

Member Visibility

On This Page

Properties
Methods