web/admin: update stage descriptions (#18118)

* Updates the description for stages to standardize lanauge and clarify.

* Add "based"

Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Remove "currently"

Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

* Fix user_write stage

Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

---------

Signed-off-by: Dewi Roberts <dewi@goauthentik.io>

authentik/enterprise/stages/authenticator_endpoint_gdtc/models.py

@@ -16,7 +16,7 @@ from authentik.stages.authenticator.models import Device
 
 
 class AuthenticatorEndpointGDTCStage(ConfigurableStage, FriendlyNamedStage, Stage):
-    """Setup Google Chrome Device Trust connection"""
+    """Verify Google Chrome Device Trust connection for the user's browser."""
 
     credentials = models.JSONField()
 

authentik/enterprise/stages/source/models.py

@@ -10,7 +10,7 @@ from authentik.lib.utils.time import timedelta_string_validator
 
 
 class SourceStage(Stage):
-    """Suspend the current flow execution and send the user to a source,
+    """Suspend the current flow execution and send the user to a federated source,
     after which this flow execution is resumed."""
 
     source = models.ForeignKey("authentik_core.Source", on_delete=models.CASCADE)

authentik/stages/authenticator_duo/models.py

@@ -16,7 +16,7 @@ from authentik.stages.authenticator.models import Device
 
 
 class AuthenticatorDuoStage(ConfigurableStage, FriendlyNamedStage, Stage):
-    """Setup Duo authenticator devices"""
+    """Setup Duo authentication for the user."""
 
     api_hostname = models.TextField()
 

authentik/stages/authenticator_email/models.py

@@ -20,7 +20,7 @@ from authentik.stages.email.utils import TemplateEmailMessage
 
 
 class AuthenticatorEmailStage(ConfigurableStage, FriendlyNamedStage, Stage):
-    """Use Email-based authentication instead of authenticator-based."""
+    """Setup Email-based authentication for the user."""
 
     use_global_settings = models.BooleanField(
         default=False,

authentik/stages/authenticator_static/models.py

@@ -16,7 +16,7 @@ from authentik.stages.authenticator.models import Device, ThrottlingMixin
 
 
 class AuthenticatorStaticStage(ConfigurableStage, FriendlyNamedStage, Stage):
-    """Generate static tokens for the user as a backup."""
+    """Setup static token based authentication for the user."""
 
     token_count = models.PositiveIntegerField(default=6)
     token_length = models.PositiveIntegerField(default=12)

authentik/stages/authenticator_totp/models.py

@@ -27,7 +27,7 @@ class TOTPDigits(models.TextChoices):
 
 
 class AuthenticatorTOTPStage(ConfigurableStage, FriendlyNamedStage, Stage):
-    """Enroll a user's device into Time-based OTP."""
+    """Setup Time-based OTP authentication for the user."""
 
     digits = models.IntegerField(choices=TOTPDigits.choices)
 

authentik/stages/authenticator_validate/models.py

@@ -36,7 +36,7 @@ def default_device_classes() -> list:
 
 
 class AuthenticatorValidateStage(Stage):
-    """Validate user's configured OTP Device."""
+    """Validate user's configured Multi Factor Authentication."""
 
     not_configured_action = models.TextField(
         choices=NotConfiguredAction.choices, default=NotConfiguredAction.SKIP

authentik/stages/authenticator_webauthn/models.py

@@ -68,7 +68,7 @@ class AuthenticatorAttachment(models.TextChoices):
 
 
 class AuthenticatorWebAuthnStage(ConfigurableStage, FriendlyNamedStage, Stage):
-    """Stage to enroll WebAuthn-based authenticators."""
+    """Setup WebAuthn-based authentication for the user."""
 
     user_verification = models.TextField(
         choices=UserVerification.choices,

authentik/stages/email/models.py

@@ -62,7 +62,7 @@ def get_template_choices():
 
 
 class EmailStage(Stage):
-    """Sends an Email to the user with a token to confirm their Email address."""
+    """Send an Email to the user with a token to confirm their Email address."""
 
     use_global_settings = models.BooleanField(
         default=False,

authentik/stages/identification/models.py

@@ -21,7 +21,7 @@ class UserFields(models.TextChoices):
 
 
 class IdentificationStage(Stage):
-    """Allows the user to identify themselves for authentication."""
+    """Identify the user for authentication."""
 
     user_fields = ArrayField(
         models.CharField(max_length=100, choices=UserFields.choices),

authentik/stages/password/models.py

@@ -39,7 +39,7 @@ def get_authentication_backends():
 
 
 class PasswordStage(ConfigurableStage, Stage):
-    """Prompts the user for their password, and validates it against the configured backends."""
+    """Prompt the user for their password, and validate it against the configured backends."""
 
     backends = ArrayField(
         models.TextField(choices=get_authentication_backends()),

authentik/stages/prompt/models.py

@@ -329,7 +329,7 @@ class Prompt(SerializerModel):
 
 
 class PromptStage(Stage):
-    """Define arbitrary prompts for the user."""
+    """Prompt the user to enter information."""
 
     fields = models.ManyToManyField(Prompt)
 

authentik/stages/redirect/models.py

@@ -16,7 +16,7 @@ class RedirectMode(models.TextChoices):
 
 
 class RedirectStage(Stage):
-    """Redirect the user to another flow, potentially with all gathered context"""
+    """Redirect the user to another flow, potentially with all gathered context."""
 
     keep_context = models.BooleanField(default=True)
     mode = models.TextField(choices=RedirectMode.choices)

authentik/stages/user_delete/models.py

@@ -8,7 +8,7 @@ from authentik.flows.models import Stage
 
 
 class UserDeleteStage(Stage):
-    """Deletes the currently pending user without confirmation.
+    """Delete the pending user without confirmation.
     Use with caution."""
 
     @property

authentik/stages/user_login/models.py

@@ -30,7 +30,7 @@ class GeoIPBinding(models.TextChoices):
 
 
 class UserLoginStage(Stage):
-    """Attaches the currently pending user to the current session."""
+    """Attach the pending user to the current session."""
 
     session_duration = models.TextField(
         default="seconds=0",

authentik/stages/user_logout/models.py

@@ -8,7 +8,7 @@ from authentik.flows.models import Stage
 
 
 class UserLogoutStage(Stage):
-    """Resets the users current session."""
+    """Ends the user's session."""
 
     @property
     def serializer(self) -> type[BaseSerializer]:

authentik/stages/user_write/models.py

@@ -18,8 +18,8 @@ class UserCreationMode(models.TextChoices):
 
 
 class UserWriteStage(Stage):
-    """Writes currently pending data into the pending user, or if no user exists,
-    creates a new user with the data."""
+    """Write pending data into the pending user, or if no user exists,
+    create a new user with the data."""
 
     user_creation_mode = models.TextField(
         choices=UserCreationMode.choices,