authentik.enterprise.providers.ssf.api.streams

SSF Stream API Views

 1"""SSF Stream API Views"""
 2
 3from rest_framework import mixins
 4from rest_framework.viewsets import GenericViewSet
 5
 6from authentik.core.api.utils import ModelSerializer
 7from authentik.enterprise.providers.ssf.api.providers import SSFProviderSerializer
 8from authentik.enterprise.providers.ssf.models import Stream
 9
10
11class SSFStreamSerializer(ModelSerializer):
12    """SSFStream Serializer"""
13
14    provider_obj = SSFProviderSerializer(source="provider", read_only=True)
15
16    class Meta:
17        model = Stream
18        fields = [
19            "pk",
20            "status",
21            "provider",
22            "provider_obj",
23            "delivery_method",
24            "endpoint_url",
25            "events_requested",
26            "format",
27            "aud",
28            "iss",
29        ]
30
31
32class SSFStreamViewSet(
33    mixins.RetrieveModelMixin,
34    mixins.DestroyModelMixin,
35    mixins.ListModelMixin,
36    GenericViewSet,
37):
38    """SSFStream Viewset"""
39
40    queryset = Stream.objects.all()
41    serializer_class = SSFStreamSerializer
42    filterset_fields = ["provider", "endpoint_url", "delivery_method"]
43    search_fields = ["provider__name", "endpoint_url"]
44    ordering = ["provider", "uuid"]
class SSFStreamSerializer(authentik.core.api.utils.ModelSerializer): 
12class SSFStreamSerializer(ModelSerializer):
13    """SSFStream Serializer"""
14
15    provider_obj = SSFProviderSerializer(source="provider", read_only=True)
16
17    class Meta:
18        model = Stream
19        fields = [
20            "pk",
21            "status",
22            "provider",
23            "provider_obj",
24            "delivery_method",
25            "endpoint_url",
26            "events_requested",
27            "format",
28            "aud",
29            "iss",
30        ]

SSFStream Serializer

provider_obj
Inherited Members
authentik.core.api.utils.ModelSerializer
serializer_field_mapping
update
class SSFStreamSerializer.Meta: 
17    class Meta:
18        model = Stream
19        fields = [
20            "pk",
21            "status",
22            "provider",
23            "provider_obj",
24            "delivery_method",
25            "endpoint_url",
26            "events_requested",
27            "format",
28            "aud",
29            "iss",
30        ]
fields = ['pk', 'status', 'provider', 'provider_obj', 'delivery_method', 'endpoint_url', 'events_requested', 'format', 'aud', 'iss']
class SSFStreamViewSet(rest_framework.mixins.RetrieveModelMixin, rest_framework.mixins.DestroyModelMixin, rest_framework.mixins.ListModelMixin, rest_framework.viewsets.GenericViewSet): 
33class SSFStreamViewSet(
34    mixins.RetrieveModelMixin,
35    mixins.DestroyModelMixin,
36    mixins.ListModelMixin,
37    GenericViewSet,
38):
39    """SSFStream Viewset"""
40
41    queryset = Stream.objects.all()
42    serializer_class = SSFStreamSerializer
43    filterset_fields = ["provider", "endpoint_url", "delivery_method"]
44    search_fields = ["provider__name", "endpoint_url"]
45    ordering = ["provider", "uuid"]

SSFStream Viewset

queryset = <QuerySet []>
serializer_class = <class 'SSFStreamSerializer'>
filterset_fields = ['provider', 'endpoint_url', 'delivery_method']
search_fields = ['provider__name', 'endpoint_url']
ordering = ['provider', 'uuid']
name = None
description = None
suffix = None
detail = None
basename = None