From 1cc5fa14122cfa457c5ae8df29f0c5c51f38bae2 Mon Sep 17 00:00:00 2001 From: Dewi Roberts Date: Thu, 13 Nov 2025 20:40:13 +0000 Subject: [PATCH] web/admin: update stage descriptions (#18118) * Updates the description for stages to standardize lanauge and clarify. * Add "based" Signed-off-by: Dewi Roberts * Remove "currently" Signed-off-by: Dewi Roberts * Fix user_write stage Signed-off-by: Dewi Roberts --------- Signed-off-by: Dewi Roberts --- .../enterprise/stages/authenticator_endpoint_gdtc/models.py | 2 +- authentik/enterprise/stages/source/models.py | 2 +- authentik/stages/authenticator_duo/models.py | 2 +- authentik/stages/authenticator_email/models.py | 2 +- authentik/stages/authenticator_static/models.py | 2 +- authentik/stages/authenticator_totp/models.py | 2 +- authentik/stages/authenticator_validate/models.py | 2 +- authentik/stages/authenticator_webauthn/models.py | 2 +- authentik/stages/email/models.py | 2 +- authentik/stages/identification/models.py | 2 +- authentik/stages/password/models.py | 2 +- authentik/stages/prompt/models.py | 2 +- authentik/stages/redirect/models.py | 2 +- authentik/stages/user_delete/models.py | 2 +- authentik/stages/user_login/models.py | 2 +- authentik/stages/user_logout/models.py | 2 +- authentik/stages/user_write/models.py | 4 ++-- 17 files changed, 18 insertions(+), 18 deletions(-) diff --git a/authentik/enterprise/stages/authenticator_endpoint_gdtc/models.py b/authentik/enterprise/stages/authenticator_endpoint_gdtc/models.py index 21d146703f..16c232fce9 100644 --- a/authentik/enterprise/stages/authenticator_endpoint_gdtc/models.py +++ b/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() diff --git a/authentik/enterprise/stages/source/models.py b/authentik/enterprise/stages/source/models.py index ac3fedeb7f..5bd7ab7ee8 100644 --- a/authentik/enterprise/stages/source/models.py +++ b/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) diff --git a/authentik/stages/authenticator_duo/models.py b/authentik/stages/authenticator_duo/models.py index f9726021d4..1690927ffa 100644 --- a/authentik/stages/authenticator_duo/models.py +++ b/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() diff --git a/authentik/stages/authenticator_email/models.py b/authentik/stages/authenticator_email/models.py index 13c0b352c6..03cd964ec4 100644 --- a/authentik/stages/authenticator_email/models.py +++ b/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, diff --git a/authentik/stages/authenticator_static/models.py b/authentik/stages/authenticator_static/models.py index 77af9b24a0..f9ac8012bf 100644 --- a/authentik/stages/authenticator_static/models.py +++ b/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) diff --git a/authentik/stages/authenticator_totp/models.py b/authentik/stages/authenticator_totp/models.py index 6275af6a03..6a7d2adb67 100644 --- a/authentik/stages/authenticator_totp/models.py +++ b/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) diff --git a/authentik/stages/authenticator_validate/models.py b/authentik/stages/authenticator_validate/models.py index 5f53ade295..94d2141bf0 100644 --- a/authentik/stages/authenticator_validate/models.py +++ b/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 diff --git a/authentik/stages/authenticator_webauthn/models.py b/authentik/stages/authenticator_webauthn/models.py index a9b13fb288..9059786b5d 100644 --- a/authentik/stages/authenticator_webauthn/models.py +++ b/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, diff --git a/authentik/stages/email/models.py b/authentik/stages/email/models.py index 959d0bf9de..e756a587bc 100644 --- a/authentik/stages/email/models.py +++ b/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, diff --git a/authentik/stages/identification/models.py b/authentik/stages/identification/models.py index b6a04cb3f6..0495f0956d 100644 --- a/authentik/stages/identification/models.py +++ b/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), diff --git a/authentik/stages/password/models.py b/authentik/stages/password/models.py index 7fe44e45f3..7034ca8f07 100644 --- a/authentik/stages/password/models.py +++ b/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()), diff --git a/authentik/stages/prompt/models.py b/authentik/stages/prompt/models.py index 8868b16baf..62cc20460a 100644 --- a/authentik/stages/prompt/models.py +++ b/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) diff --git a/authentik/stages/redirect/models.py b/authentik/stages/redirect/models.py index a022ed88b9..271e149881 100644 --- a/authentik/stages/redirect/models.py +++ b/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) diff --git a/authentik/stages/user_delete/models.py b/authentik/stages/user_delete/models.py index be7aec4d35..7d45077ef8 100644 --- a/authentik/stages/user_delete/models.py +++ b/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 diff --git a/authentik/stages/user_login/models.py b/authentik/stages/user_login/models.py index 810fd27c68..b3f2dbb07a 100644 --- a/authentik/stages/user_login/models.py +++ b/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", diff --git a/authentik/stages/user_logout/models.py b/authentik/stages/user_logout/models.py index 92fd36c99a..559ca3eaca 100644 --- a/authentik/stages/user_logout/models.py +++ b/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]: diff --git a/authentik/stages/user_write/models.py b/authentik/stages/user_write/models.py index a4e94a71b9..91b79e824f 100644 --- a/authentik/stages/user_write/models.py +++ b/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,