authentik.stages.consent.api

ConsentStage API Views

 1"""ConsentStage API Views"""
 2
 3from rest_framework import mixins
 4from rest_framework.viewsets import GenericViewSet, ModelViewSet
 5
 6from authentik.core.api.applications import ApplicationSerializer
 7from authentik.core.api.used_by import UsedByMixin
 8from authentik.core.api.users import UserSerializer
 9from authentik.flows.api.stages import StageSerializer
10from authentik.stages.consent.models import ConsentStage, UserConsent
11
12
13class ConsentStageSerializer(StageSerializer):
14    """ConsentStage Serializer"""
15
16    class Meta:
17        model = ConsentStage
18        fields = StageSerializer.Meta.fields + ["mode", "consent_expire_in"]
19
20
21class ConsentStageViewSet(UsedByMixin, ModelViewSet):
22    """ConsentStage Viewset"""
23
24    queryset = ConsentStage.objects.all()
25    serializer_class = ConsentStageSerializer
26    filterset_fields = "__all__"
27    ordering = ["name"]
28    search_fields = ["name"]
29
30
31class UserConsentSerializer(StageSerializer):
32    """UserConsent Serializer"""
33
34    user = UserSerializer()
35    application = ApplicationSerializer()
36
37    class Meta:
38        model = UserConsent
39        fields = ["pk", "expires", "expiring", "user", "application", "permissions"]
40
41
42class UserConsentViewSet(
43    mixins.RetrieveModelMixin,
44    mixins.DestroyModelMixin,
45    UsedByMixin,
46    mixins.ListModelMixin,
47    GenericViewSet,
48):
49    """UserConsent Viewset"""
50
51    queryset = UserConsent.objects.including_expired().all()
52    serializer_class = UserConsentSerializer
53    filterset_fields = ["user", "application"]
54    ordering = ["application", "expires"]
55    search_fields = ["user__username"]
56    owner_field = "user"
class ConsentStageSerializer(authentik.flows.api.stages.StageSerializer):
14class ConsentStageSerializer(StageSerializer):
15    """ConsentStage Serializer"""
16
17    class Meta:
18        model = ConsentStage
19        fields = StageSerializer.Meta.fields + ["mode", "consent_expire_in"]

ConsentStage Serializer

class ConsentStageSerializer.Meta:
17    class Meta:
18        model = ConsentStage
19        fields = StageSerializer.Meta.fields + ["mode", "consent_expire_in"]
fields = ['pk', 'name', 'component', 'verbose_name', 'verbose_name_plural', 'meta_model_name', 'flow_set', 'mode', 'consent_expire_in']
class ConsentStageViewSet(authentik.core.api.used_by.UsedByMixin, rest_framework.viewsets.ModelViewSet):
22class ConsentStageViewSet(UsedByMixin, ModelViewSet):
23    """ConsentStage Viewset"""
24
25    queryset = ConsentStage.objects.all()
26    serializer_class = ConsentStageSerializer
27    filterset_fields = "__all__"
28    ordering = ["name"]
29    search_fields = ["name"]

ConsentStage Viewset

queryset = <InheritanceQuerySet []>
serializer_class = <class 'ConsentStageSerializer'>
filterset_fields = '__all__'
ordering = ['name']
search_fields = ['name']
name = None
description = None
suffix = None
detail = None
basename = None
class UserConsentSerializer(authentik.flows.api.stages.StageSerializer):
32class UserConsentSerializer(StageSerializer):
33    """UserConsent Serializer"""
34
35    user = UserSerializer()
36    application = ApplicationSerializer()
37
38    class Meta:
39        model = UserConsent
40        fields = ["pk", "expires", "expiring", "user", "application", "permissions"]

UserConsent Serializer

user
application
class UserConsentSerializer.Meta:
38    class Meta:
39        model = UserConsent
40        fields = ["pk", "expires", "expiring", "user", "application", "permissions"]
fields = ['pk', 'expires', 'expiring', 'user', 'application', 'permissions']
class UserConsentViewSet(rest_framework.mixins.RetrieveModelMixin, rest_framework.mixins.DestroyModelMixin, authentik.core.api.used_by.UsedByMixin, rest_framework.mixins.ListModelMixin, rest_framework.viewsets.GenericViewSet):
43class UserConsentViewSet(
44    mixins.RetrieveModelMixin,
45    mixins.DestroyModelMixin,
46    UsedByMixin,
47    mixins.ListModelMixin,
48    GenericViewSet,
49):
50    """UserConsent Viewset"""
51
52    queryset = UserConsent.objects.including_expired().all()
53    serializer_class = UserConsentSerializer
54    filterset_fields = ["user", "application"]
55    ordering = ["application", "expires"]
56    search_fields = ["user__username"]
57    owner_field = "user"

UserConsent Viewset

queryset = <QuerySet []>
serializer_class = <class 'UserConsentSerializer'>
filterset_fields = ['user', 'application']
ordering = ['application', 'expires']
search_fields = ['user__username']
owner_field = 'user'
name = None
description = None
suffix = None
detail = None
basename = None