authentik.stages.captcha.api

CaptchaStage API Views

View Source

 1"""CaptchaStage API Views"""
 2
 3from rest_framework.viewsets import ModelViewSet
 4
 5from authentik.core.api.used_by import UsedByMixin
 6from authentik.flows.api.stages import StageSerializer
 7from authentik.stages.captcha.models import CaptchaStage
 8
 9
10class CaptchaStageSerializer(StageSerializer):
11    """CaptchaStage Serializer"""
12
13    class Meta:
14        model = CaptchaStage
15        fields = StageSerializer.Meta.fields + [
16            "public_key",
17            "private_key",
18            "js_url",
19            "api_url",
20            "interactive",
21            "score_min_threshold",
22            "score_max_threshold",
23            "error_on_invalid_score",
24        ]
25        extra_kwargs = {"private_key": {"write_only": True}}
26
27
28class CaptchaStageViewSet(UsedByMixin, ModelViewSet):
29    """CaptchaStage Viewset"""
30
31    queryset = CaptchaStage.objects.all()
32    serializer_class = CaptchaStageSerializer
33    filterset_fields = ["name", "public_key"]
34    search_fields = ["name"]
35    ordering = ["name"]

class CaptchaStageSerializer(authentik.flows.api.stages.StageSerializer): View Source

11class CaptchaStageSerializer(StageSerializer):
12    """CaptchaStage Serializer"""
13
14    class Meta:
15        model = CaptchaStage
16        fields = StageSerializer.Meta.fields + [
17            "public_key",
18            "private_key",
19            "js_url",
20            "api_url",
21            "interactive",
22            "score_min_threshold",
23            "score_max_threshold",
24            "error_on_invalid_score",
25        ]
26        extra_kwargs = {"private_key": {"write_only": True}}

CaptchaStage 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 CaptchaStageSerializer.Meta: View Source

14    class Meta:
15        model = CaptchaStage
16        fields = StageSerializer.Meta.fields + [
17            "public_key",
18            "private_key",
19            "js_url",
20            "api_url",
21            "interactive",
22            "score_min_threshold",
23            "score_max_threshold",
24            "error_on_invalid_score",
25        ]
26        extra_kwargs = {"private_key": {"write_only": True}}

model = <class 'authentik.stages.captcha.models.CaptchaStage'>

fields = ['pk', 'name', 'component', 'verbose_name', 'verbose_name_plural', 'meta_model_name', 'flow_set', 'public_key', 'private_key', 'js_url', 'api_url', 'interactive', 'score_min_threshold', 'score_max_threshold', 'error_on_invalid_score']

extra_kwargs = {'private_key': {'write_only': True}}

class CaptchaStageViewSet(authentik.core.api.used_by.UsedByMixin, rest_framework.viewsets.ModelViewSet): View Source

29class CaptchaStageViewSet(UsedByMixin, ModelViewSet):
30    """CaptchaStage Viewset"""
31
32    queryset = CaptchaStage.objects.all()
33    serializer_class = CaptchaStageSerializer
34    filterset_fields = ["name", "public_key"]
35    search_fields = ["name"]
36    ordering = ["name"]

CaptchaStage Viewset

queryset = <InheritanceQuerySet []>

serializer_class = <class 'CaptchaStageSerializer'>

filterset_fields = ['name', 'public_key']

search_fields = ['name']

ordering = ['name']

name = None

description = None

suffix = None

detail = None

basename = None

Inherited Members

authentik.core.api.used_by.UsedByMixin: used_by