authentik.stages.user_write.models

 1"""write stage models"""
 2
 3from django.db import models
 4from django.utils.translation import gettext_lazy as _
 5from django.views import View
 6from rest_framework.serializers import BaseSerializer
 7
 8from authentik.core.models import Group, UserTypes
 9from authentik.flows.models import Stage
10
11
12class UserCreationMode(models.TextChoices):
13    """Behavior of user_write stage when a user is not set in the flow context"""
14
15    NEVER_CREATE = "never_create"
16    CREATE_WHEN_REQUIRED = "create_when_required"
17    ALWAYS_CREATE = "always_create"
18
19
20class UserWriteStage(Stage):
21    """Write pending data into the pending user, or if no user exists,
22    create a new user with the data."""
23
24    user_creation_mode = models.TextField(
25        choices=UserCreationMode.choices,
26        default=UserCreationMode.CREATE_WHEN_REQUIRED,
27    )
28
29    create_users_as_inactive = models.BooleanField(
30        default=False,
31        help_text=_("When set, newly created users are inactive and cannot login."),
32    )
33
34    create_users_group = models.ForeignKey(
35        Group,
36        null=True,
37        default=None,
38        on_delete=models.SET_DEFAULT,
39        help_text=_("Optionally add newly created users to this group."),
40    )
41
42    user_type = models.TextField(
43        choices=UserTypes.choices,
44        default=UserTypes.EXTERNAL,
45    )
46    user_path_template = models.TextField(
47        default="",
48        blank=True,
49    )
50
51    @property
52    def serializer(self) -> type[BaseSerializer]:
53        from authentik.stages.user_write.api import UserWriteStageSerializer
54
55        return UserWriteStageSerializer
56
57    @property
58    def view(self) -> type[View]:
59        from authentik.stages.user_write.stage import UserWriteStageView
60
61        return UserWriteStageView
62
63    @property
64    def component(self) -> str:
65        return "ak-stage-user-write-form"
66
67    class Meta:
68        verbose_name = _("User Write Stage")
69        verbose_name_plural = _("User Write Stages")