authentik.sources.scim.api.users

SCIMSourceUser API Views

 1"""SCIMSourceUser API Views"""
 2
 3from rest_framework.viewsets import ModelViewSet
 4
 5from authentik.core.api.groups import PartialUserSerializer
 6from authentik.core.api.sources import SourceSerializer
 7from authentik.core.api.used_by import UsedByMixin
 8from authentik.sources.scim.models import SCIMSourceUser
 9
10
11class SCIMSourceUserSerializer(SourceSerializer):
12    """SCIMSourceUser Serializer"""
13
14    user_obj = PartialUserSerializer(source="user", read_only=True)
15
16    class Meta:
17
18        model = SCIMSourceUser
19        fields = [
20            "id",
21            "external_id",
22            "user",
23            "user_obj",
24            "source",
25            "attributes",
26        ]
27
28
29class SCIMSourceUserViewSet(UsedByMixin, ModelViewSet):
30    """SCIMSourceUser Viewset"""
31
32    queryset = SCIMSourceUser.objects.all().select_related("user")
33    serializer_class = SCIMSourceUserSerializer
34    filterset_fields = ["source__slug", "user__username", "user__id"]
35    search_fields = ["source__slug", "user__username", "attributes", "user__uuid", "external_id"]
36    ordering = ["user__username"]
class SCIMSourceUserSerializer(authentik.core.api.sources.SourceSerializer): 
12class SCIMSourceUserSerializer(SourceSerializer):
13    """SCIMSourceUser Serializer"""
14
15    user_obj = PartialUserSerializer(source="user", read_only=True)
16
17    class Meta:
18
19        model = SCIMSourceUser
20        fields = [
21            "id",
22            "external_id",
23            "user",
24            "user_obj",
25            "source",
26            "attributes",
27        ]

SCIMSourceUser Serializer

user_obj
Inherited Members
authentik.core.api.sources.SourceSerializer
managed
component
icon_url
icon_themed_urls
get_component
authentik.core.api.utils.ModelSerializer
serializer_field_mapping
update
authentik.core.api.utils.MetaNameSerializer
verbose_name
verbose_name_plural
meta_model_name
get_verbose_name
get_verbose_name_plural
get_meta_model_name
class SCIMSourceUserSerializer.Meta: 
17    class Meta:
18
19        model = SCIMSourceUser
20        fields = [
21            "id",
22            "external_id",
23            "user",
24            "user_obj",
25            "source",
26            "attributes",
27        ]
fields = ['id', 'external_id', 'user', 'user_obj', 'source', 'attributes']
class SCIMSourceUserViewSet(authentik.core.api.used_by.UsedByMixin, rest_framework.viewsets.ModelViewSet): 
30class SCIMSourceUserViewSet(UsedByMixin, ModelViewSet):
31    """SCIMSourceUser Viewset"""
32
33    queryset = SCIMSourceUser.objects.all().select_related("user")
34    serializer_class = SCIMSourceUserSerializer
35    filterset_fields = ["source__slug", "user__username", "user__id"]
36    search_fields = ["source__slug", "user__username", "attributes", "user__uuid", "external_id"]
37    ordering = ["user__username"]

SCIMSourceUser Viewset

queryset = <QuerySet []>
serializer_class = <class 'SCIMSourceUserSerializer'>
filterset_fields = ['source__slug', 'user__username', 'user__id']
search_fields = ['source__slug', 'user__username', 'attributes', 'user__uuid', 'external_id']
ordering = ['user__username']
name = None
description = None
suffix = None
detail = None
basename = None
Inherited Members
authentik.core.api.used_by.UsedByMixin
used_by