feat: add users and groups API routes

src/paperless/filters.py

@@ -0,0 +1,20 @@
+from django.contrib.auth.models import Group
+from django.contrib.auth.models import User
+from django_filters.rest_framework import FilterSet
+
+CHAR_KWARGS = ["istartswith", "iendswith", "icontains", "iexact"]
+ID_KWARGS = ["in", "exact"]
+INT_KWARGS = ["exact", "gt", "gte", "lt", "lte", "isnull"]
+DATE_KWARGS = ["year", "month", "day", "date__gt", "gt", "date__lt", "lt"]
+
+
+class UserFilterSet(FilterSet):
+    class Meta:
+        model = User
+        fields = {"username": CHAR_KWARGS}
+
+
+class GroupFilterSet(FilterSet):
+    class Meta:
+        model = Group
+        fields = {"name": CHAR_KWARGS}

src/paperless/serialisers.py

@@ -0,0 +1,64 @@
+from django.contrib.auth.models import Group
+from django.contrib.auth.models import User
+from rest_framework import serializers
+
+
+class UserSerializer(serializers.ModelSerializer):
+
+    groups = serializers.SerializerMethodField()
+    permissions = serializers.SerializerMethodField()
+    inherited_permissions = serializers.SerializerMethodField()
+
+    class Meta:
+        model = User
+        fields = (
+            "id",
+            "username",
+            "first_name",
+            "last_name",
+            "date_joined",
+            "is_staff",
+            "is_active",
+            "is_superuser",
+            "groups",
+            "permissions",
+            "inherited_permissions",
+        )
+
+    def get_groups(self, obj):
+        return list(obj.groups.values_list("name", flat=True))
+
+    def get_permissions(self, obj):
+        # obj.get_user_permissions() returns more permissions than desired
+        permission_natural_keys = []
+        permissions = obj.user_permissions.all()
+        for permission in permissions:
+            permission_natural_keys.append(
+                permission.natural_key()[1] + "." + permission.natural_key()[0],
+            )
+        return permission_natural_keys
+
+    def get_inherited_permissions(self, obj):
+        return obj.get_group_permissions()
+
+
+class GroupSerializer(serializers.ModelSerializer):
+
+    permissions = serializers.SerializerMethodField()
+
+    class Meta:
+        model = Group
+        fields = (
+            "id",
+            "name",
+            "permissions",
+        )
+
+    def get_permissions(self, obj):
+        permission_natural_keys = []
+        permissions = obj.permissions.all()
+        for permission in permissions:
+            permission_natural_keys.append(
+                permission.natural_key()[1] + "." + permission.natural_key()[0],
+            )
+        return permission_natural_keys

src/paperless/urls.py

@@ -27,6 +27,8 @@ from documents.views import UiSettingsView
 from documents.views import UnifiedSearchViewSet
 from paperless.consumers import StatusConsumer
 from paperless.views import FaviconView
+from paperless.views import GroupViewSet
+from paperless.views import UserViewSet
 from rest_framework.authtoken import views
 from rest_framework.routers import DefaultRouter
 
@@ -39,6 +41,8 @@ api_router.register(r"tags", TagViewSet)
 api_router.register(r"saved_views", SavedViewViewSet)
 api_router.register(r"storage_paths", StoragePathViewSet)
 api_router.register(r"tasks", TasksViewSet, basename="tasks")
+api_router.register(r"users", UserViewSet, basename="users")
+api_router.register(r"groups", GroupViewSet, basename="groups")
 
 
 urlpatterns = [

src/paperless/views.py

@@ -1,8 +1,19 @@
 import os
 
+from django.contrib.auth.models import Group
+from django.contrib.auth.models import User
+from django.db.models.functions import Lower
 from django.http import HttpResponse
 from django.views.generic import View
+from django_filters.rest_framework import DjangoFilterBackend
+from paperless.filters import GroupFilterSet
+from paperless.filters import UserFilterSet
+from paperless.serialisers import GroupSerializer
+from paperless.serialisers import UserSerializer
+from rest_framework.filters import OrderingFilter
 from rest_framework.pagination import PageNumberPagination
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.viewsets import ModelViewSet
 
 
 class StandardPagination(PageNumberPagination):
@@ -22,3 +33,29 @@ class FaviconView(View):
         )
         with open(favicon, "rb") as f:
             return HttpResponse(f, content_type="image/x-icon")
+
+
+class UserViewSet(ModelViewSet):
+    model = User
+
+    queryset = User.objects.order_by(Lower("username"))
+
+    serializer_class = UserSerializer
+    pagination_class = StandardPagination
+    permission_classes = (IsAuthenticated,)
+    filter_backends = (DjangoFilterBackend, OrderingFilter)
+    filterset_class = UserFilterSet
+    ordering_fields = ("username",)
+
+
+class GroupViewSet(ModelViewSet):
+    model = Group
+
+    queryset = Group.objects.order_by(Lower("name"))
+
+    serializer_class = GroupSerializer
+    pagination_class = StandardPagination
+    permission_classes = (IsAuthenticated,)
+    filter_backends = (DjangoFilterBackend, OrderingFilter)
+    filterset_class = GroupFilterSet
+    ordering_fields = ("name",)