authentik.providers.scim.api.users

SCIMProviderUser API Views

 1"""SCIMProviderUser API Views"""
 2
 3from rest_framework import mixins
 4from rest_framework.viewsets import GenericViewSet
 5
 6from authentik.core.api.groups import PartialUserSerializer
 7from authentik.core.api.used_by import UsedByMixin
 8from authentik.core.api.utils import ModelSerializer
 9from authentik.lib.sync.outgoing.api import OutgoingSyncConnectionCreateMixin
10from authentik.providers.scim.models import SCIMProviderUser
11
12
13class SCIMProviderUserSerializer(ModelSerializer):
14    """SCIMProviderUser Serializer"""
15
16    user_obj = PartialUserSerializer(source="user", read_only=True)
17
18    class Meta:
19
20        model = SCIMProviderUser
21        fields = [
22            "id",
23            "scim_id",
24            "user",
25            "user_obj",
26            "provider",
27            "attributes",
28        ]
29        extra_kwargs = {"attributes": {"read_only": True}}
30
31
32class SCIMProviderUserViewSet(
33    mixins.CreateModelMixin,
34    OutgoingSyncConnectionCreateMixin,
35    mixins.RetrieveModelMixin,
36    mixins.DestroyModelMixin,
37    UsedByMixin,
38    mixins.ListModelMixin,
39    GenericViewSet,
40):
41    """SCIMProviderUser Viewset"""
42
43    queryset = SCIMProviderUser.objects.all().select_related("user")
44    serializer_class = SCIMProviderUserSerializer
45    filterset_fields = ["provider__id", "user__username", "user__id"]
46    search_fields = ["provider__name", "user__username"]
47    ordering = ["user__username"]
class SCIMProviderUserSerializer(authentik.core.api.utils.ModelSerializer): 
14class SCIMProviderUserSerializer(ModelSerializer):
15    """SCIMProviderUser Serializer"""
16
17    user_obj = PartialUserSerializer(source="user", read_only=True)
18
19    class Meta:
20
21        model = SCIMProviderUser
22        fields = [
23            "id",
24            "scim_id",
25            "user",
26            "user_obj",
27            "provider",
28            "attributes",
29        ]
30        extra_kwargs = {"attributes": {"read_only": True}}

SCIMProviderUser Serializer

user_obj
Inherited Members
authentik.core.api.utils.ModelSerializer
serializer_field_mapping
update
class SCIMProviderUserSerializer.Meta: 
19    class Meta:
20
21        model = SCIMProviderUser
22        fields = [
23            "id",
24            "scim_id",
25            "user",
26            "user_obj",
27            "provider",
28            "attributes",
29        ]
30        extra_kwargs = {"attributes": {"read_only": True}}
fields = ['id', 'scim_id', 'user', 'user_obj', 'provider', 'attributes']
extra_kwargs = {'attributes': {'read_only': True}}
class SCIMProviderUserViewSet(rest_framework.mixins.CreateModelMixin, authentik.lib.sync.outgoing.api.OutgoingSyncConnectionCreateMixin, rest_framework.mixins.RetrieveModelMixin, rest_framework.mixins.DestroyModelMixin, authentik.core.api.used_by.UsedByMixin, rest_framework.mixins.ListModelMixin, rest_framework.viewsets.GenericViewSet): 
33class SCIMProviderUserViewSet(
34    mixins.CreateModelMixin,
35    OutgoingSyncConnectionCreateMixin,
36    mixins.RetrieveModelMixin,
37    mixins.DestroyModelMixin,
38    UsedByMixin,
39    mixins.ListModelMixin,
40    GenericViewSet,
41):
42    """SCIMProviderUser Viewset"""
43
44    queryset = SCIMProviderUser.objects.all().select_related("user")
45    serializer_class = SCIMProviderUserSerializer
46    filterset_fields = ["provider__id", "user__username", "user__id"]
47    search_fields = ["provider__name", "user__username"]
48    ordering = ["user__username"]

SCIMProviderUser Viewset

queryset = <QuerySet []>
serializer_class = <class 'SCIMProviderUserSerializer'>
filterset_fields = ['provider__id', 'user__username', 'user__id']
search_fields = ['provider__name', 'user__username']
ordering = ['user__username']
name = None
description = None
suffix = None
detail = None
basename = None
Inherited Members
authentik.core.api.used_by.UsedByMixin
used_by