authentik.stages.authenticator_sms.api

AuthenticatorSMSStage API Views

 1"""AuthenticatorSMSStage API Views"""
 2
 3from rest_framework import mixins
 4from rest_framework.viewsets import GenericViewSet, ModelViewSet
 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.flows.api.stages import StageSerializer
10from authentik.stages.authenticator_sms.models import AuthenticatorSMSStage, SMSDevice
11
12
13class AuthenticatorSMSStageSerializer(StageSerializer):
14    """AuthenticatorSMSStage Serializer"""
15
16    class Meta:
17        model = AuthenticatorSMSStage
18        fields = StageSerializer.Meta.fields + [
19            "configure_flow",
20            "friendly_name",
21            "provider",
22            "from_number",
23            "account_sid",
24            "auth",
25            "auth_password",
26            "auth_type",
27            "verify_only",
28            "mapping",
29        ]
30
31
32class AuthenticatorSMSStageViewSet(UsedByMixin, ModelViewSet):
33    """AuthenticatorSMSStage Viewset"""
34
35    queryset = AuthenticatorSMSStage.objects.all()
36    serializer_class = AuthenticatorSMSStageSerializer
37    filterset_fields = "__all__"
38    ordering = ["name"]
39    search_fields = ["name"]
40
41
42class SMSDeviceSerializer(ModelSerializer):
43    """Serializer for sms authenticator devices"""
44
45    user = PartialUserSerializer(read_only=True)
46
47    class Meta:
48        model = SMSDevice
49        fields = ["name", "pk", "phone_number", "user"]
50        depth = 2
51        extra_kwargs = {
52            "phone_number": {"read_only": True},
53        }
54
55
56class SMSDeviceViewSet(
57    mixins.RetrieveModelMixin,
58    mixins.UpdateModelMixin,
59    mixins.DestroyModelMixin,
60    UsedByMixin,
61    mixins.ListModelMixin,
62    GenericViewSet,
63):
64    """Viewset for sms authenticator devices"""
65
66    queryset = SMSDevice.objects.all()
67    serializer_class = SMSDeviceSerializer
68    search_fields = ["name"]
69    filterset_fields = ["name"]
70    ordering = ["name"]
71    owner_field = "user"
72
73
74class SMSAdminDeviceViewSet(ModelViewSet):
75    """Viewset for sms authenticator devices (for admins)"""
76
77    queryset = SMSDevice.objects.all()
78    serializer_class = SMSDeviceSerializer
79    search_fields = ["name"]
80    filterset_fields = ["name"]
81    ordering = ["name"]
class AuthenticatorSMSStageSerializer(authentik.flows.api.stages.StageSerializer): 
14class AuthenticatorSMSStageSerializer(StageSerializer):
15    """AuthenticatorSMSStage Serializer"""
16
17    class Meta:
18        model = AuthenticatorSMSStage
19        fields = StageSerializer.Meta.fields + [
20            "configure_flow",
21            "friendly_name",
22            "provider",
23            "from_number",
24            "account_sid",
25            "auth",
26            "auth_password",
27            "auth_type",
28            "verify_only",
29            "mapping",
30        ]

AuthenticatorSMSStage Serializer

Inherited Members
authentik.flows.api.stages.StageSerializer
component
flow_set
to_representation
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 AuthenticatorSMSStageSerializer.Meta: 
17    class Meta:
18        model = AuthenticatorSMSStage
19        fields = StageSerializer.Meta.fields + [
20            "configure_flow",
21            "friendly_name",
22            "provider",
23            "from_number",
24            "account_sid",
25            "auth",
26            "auth_password",
27            "auth_type",
28            "verify_only",
29            "mapping",
30        ]
fields = ['pk', 'name', 'component', 'verbose_name', 'verbose_name_plural', 'meta_model_name', 'flow_set', 'configure_flow', 'friendly_name', 'provider', 'from_number', 'account_sid', 'auth', 'auth_password', 'auth_type', 'verify_only', 'mapping']
class AuthenticatorSMSStageViewSet(authentik.core.api.used_by.UsedByMixin, rest_framework.viewsets.ModelViewSet): 
33class AuthenticatorSMSStageViewSet(UsedByMixin, ModelViewSet):
34    """AuthenticatorSMSStage Viewset"""
35
36    queryset = AuthenticatorSMSStage.objects.all()
37    serializer_class = AuthenticatorSMSStageSerializer
38    filterset_fields = "__all__"
39    ordering = ["name"]
40    search_fields = ["name"]

AuthenticatorSMSStage Viewset

queryset = <InheritanceQuerySet []>
serializer_class = <class 'AuthenticatorSMSStageSerializer'>
filterset_fields = '__all__'
ordering = ['name']
search_fields = ['name']
name = None
description = None
suffix = None
detail = None
basename = None
Inherited Members
authentik.core.api.used_by.UsedByMixin
used_by
class SMSDeviceSerializer(authentik.core.api.utils.ModelSerializer): 
43class SMSDeviceSerializer(ModelSerializer):
44    """Serializer for sms authenticator devices"""
45
46    user = PartialUserSerializer(read_only=True)
47
48    class Meta:
49        model = SMSDevice
50        fields = ["name", "pk", "phone_number", "user"]
51        depth = 2
52        extra_kwargs = {
53            "phone_number": {"read_only": True},
54        }

Serializer for sms authenticator devices

user
Inherited Members
authentik.core.api.utils.ModelSerializer
serializer_field_mapping
update
class SMSDeviceSerializer.Meta: 
48    class Meta:
49        model = SMSDevice
50        fields = ["name", "pk", "phone_number", "user"]
51        depth = 2
52        extra_kwargs = {
53            "phone_number": {"read_only": True},
54        }
fields = ['name', 'pk', 'phone_number', 'user']
depth = 2
extra_kwargs = {'phone_number': {'read_only': True}}
class SMSDeviceViewSet(rest_framework.mixins.RetrieveModelMixin, rest_framework.mixins.UpdateModelMixin, rest_framework.mixins.DestroyModelMixin, authentik.core.api.used_by.UsedByMixin, rest_framework.mixins.ListModelMixin, rest_framework.viewsets.GenericViewSet): 
57class SMSDeviceViewSet(
58    mixins.RetrieveModelMixin,
59    mixins.UpdateModelMixin,
60    mixins.DestroyModelMixin,
61    UsedByMixin,
62    mixins.ListModelMixin,
63    GenericViewSet,
64):
65    """Viewset for sms authenticator devices"""
66
67    queryset = SMSDevice.objects.all()
68    serializer_class = SMSDeviceSerializer
69    search_fields = ["name"]
70    filterset_fields = ["name"]
71    ordering = ["name"]
72    owner_field = "user"

Viewset for sms authenticator devices

queryset = <QuerySet []>
serializer_class = <class 'SMSDeviceSerializer'>
search_fields = ['name']
filterset_fields = ['name']
ordering = ['name']
owner_field = 'user'
name = None
description = None
suffix = None
detail = None
basename = None
Inherited Members
authentik.core.api.used_by.UsedByMixin
used_by
class SMSAdminDeviceViewSet(rest_framework.viewsets.ModelViewSet): 
75class SMSAdminDeviceViewSet(ModelViewSet):
76    """Viewset for sms authenticator devices (for admins)"""
77
78    queryset = SMSDevice.objects.all()
79    serializer_class = SMSDeviceSerializer
80    search_fields = ["name"]
81    filterset_fields = ["name"]
82    ordering = ["name"]

Viewset for sms authenticator devices (for admins)

queryset = <QuerySet []>
serializer_class = <class 'SMSDeviceSerializer'>
search_fields = ['name']
filterset_fields = ['name']
ordering = ['name']
name = None
description = None
suffix = None
detail = None
basename = None