strawberry.BasePermission

Base class for permissions. All permissions should inherit from this class.

Example:

from strawberry.permission import BasePermission


class IsAuthenticated(BasePermission):
    message = "User is not authenticated"

    def has_permission(self, source, info, **kwargs):
        return info.context["user"].is_authenticated

Methods:

• has_permission

  Check if the permission should be accepted.

  This method should be overridden by the subclasses.

  Signature:

  def has_permission(self, source: Any, info: Info, kwargs: Any = {}) -> bool | Awaitable[bool]:
    ...

  Parameters:

  1. source:

     Type

     Any

  2. info:

     Type

     Info

  3. kwargs:

     Type

     Any

     Default

     {}

• on_unauthorized

  Default error raising for permissions.

  This method can be overridden to customize the error raised when the permission is not granted.

  Example:

  from strawberry.permission import BasePermission
  
  
  class CustomPermissionError(PermissionError):
      pass
  
  
  class IsAuthenticated(BasePermission):
      message = "User is not authenticated"
  
      def has_permission(self, source, info, **kwargs):
          return info.context["user"].is_authenticated
  
      def on_unauthorized(self) -> None:
          raise CustomPermissionError(self.message)

  Signature:

  def on_unauthorized(self) -> None:
    ...

Attributes:

1. message:

   Type

   str | None

2. error_extensions:

   Type

   GraphQLErrorExtensions | None

3. error_class:

   Type

   Type[GraphQLError]

4. schema_directive:

   Type

   object