authentik.events.api.notification_rules

NotificationRule API Views

 1"""NotificationRule API Views"""
 2
 3from rest_framework.viewsets import ModelViewSet
 4
 5from authentik.core.api.groups import GroupSerializer
 6from authentik.core.api.used_by import UsedByMixin
 7from authentik.core.api.utils import ModelSerializer
 8from authentik.events.models import NotificationRule
 9
10
11class NotificationRuleSerializer(ModelSerializer):
12    """NotificationRule Serializer"""
13
14    destination_group_obj = GroupSerializer(
15        read_only=True, source="destination_group", required=False, allow_null=True
16    )
17
18    class Meta:
19        model = NotificationRule
20        fields = [
21            "pk",
22            "name",
23            "transports",
24            "severity",
25            "destination_group",
26            "destination_group_obj",
27            "destination_event_user",
28        ]
29
30
31class NotificationRuleViewSet(UsedByMixin, ModelViewSet):
32    """NotificationRule Viewset"""
33
34    queryset = NotificationRule.objects.all()
35    serializer_class = NotificationRuleSerializer
36    filterset_fields = ["name", "severity", "destination_group__name"]
37    ordering = ["name"]
38    search_fields = ["name", "destination_group__name"]
class NotificationRuleSerializer(authentik.core.api.utils.ModelSerializer): 
12class NotificationRuleSerializer(ModelSerializer):
13    """NotificationRule Serializer"""
14
15    destination_group_obj = GroupSerializer(
16        read_only=True, source="destination_group", required=False, allow_null=True
17    )
18
19    class Meta:
20        model = NotificationRule
21        fields = [
22            "pk",
23            "name",
24            "transports",
25            "severity",
26            "destination_group",
27            "destination_group_obj",
28            "destination_event_user",
29        ]

NotificationRule Serializer

destination_group_obj
Inherited Members
authentik.core.api.utils.ModelSerializer
serializer_field_mapping
update
class NotificationRuleSerializer.Meta: 
19    class Meta:
20        model = NotificationRule
21        fields = [
22            "pk",
23            "name",
24            "transports",
25            "severity",
26            "destination_group",
27            "destination_group_obj",
28            "destination_event_user",
29        ]
fields = ['pk', 'name', 'transports', 'severity', 'destination_group', 'destination_group_obj', 'destination_event_user']
class NotificationRuleViewSet(authentik.core.api.used_by.UsedByMixin, rest_framework.viewsets.ModelViewSet): 
32class NotificationRuleViewSet(UsedByMixin, ModelViewSet):
33    """NotificationRule Viewset"""
34
35    queryset = NotificationRule.objects.all()
36    serializer_class = NotificationRuleSerializer
37    filterset_fields = ["name", "severity", "destination_group__name"]
38    ordering = ["name"]
39    search_fields = ["name", "destination_group__name"]

NotificationRule Viewset

queryset = <InheritanceQuerySet []>
serializer_class = <class 'NotificationRuleSerializer'>
filterset_fields = ['name', 'severity', 'destination_group__name']
ordering = ['name']
search_fields = ['name', 'destination_group__name']
name = None
description = None
suffix = None
detail = None
basename = None
Inherited Members
authentik.core.api.used_by.UsedByMixin
used_by