Added configuration descriptions

kilmajster · Jun 7, 2021 · 28114b8 · 28114b8
1 parent 8a809f6
commit 28114b8
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/src/main/java/io/github/kilmajster/keycloak/UsernamePasswordAttributeFormConfiguration.java b/src/main/java/io/github/kilmajster/keycloak/UsernamePasswordAttributeFormConfiguration.java
@@ -21,37 +21,40 @@ public interface UsernamePasswordAttributeFormConfiguration {
             .name(LOGIN_FORM_USER_ATTRIBUTE)
             .type(ProviderConfigProperty.STRING_TYPE)
             .label("User attribute")
-            .helpText("TODO")
+            .helpText("Attribute used to validate login form.")
             .add()
 
             .property()
             .name(LOGIN_FORM_GENERATE_LABEL)
             .type(ProviderConfigProperty.BOOLEAN_TYPE)
             .label("Generate label")
             .defaultValue("true") // only string value is accepted
-            .helpText("TODO")
+            .helpText("If enabled, label for login form will be generated based on attribute name, so attribute with name:" +
+                    " \"foot_size\" will be labeled as \"Foot size\", \"REALLY_custom.user-Attribute\" will be translated " +
+                    "to \"Really custom user attribute\", etc. By default, set to true. If User attribute form label " +
+                    "is configured, label is taken form configuration and generation is skipped.")
             .add()
 
             .property()
             .name(CLEAR_USER_ON_ATTRIBUTE_VALIDATION_FAIL)
             .type(ProviderConfigProperty.BOOLEAN_TYPE)
             .label("Clear user on validation fail")
             .defaultValue("true") // only string value is accepted
-            .helpText("TODO")
+            .helpText("If enabled, user is not stored in session context in case username and password were valid but user attribute was not.")
             .add()
 
             .property()
             .name(LOGIN_FORM_ATTRIBUTE_LABEL)
             .type(ProviderConfigProperty.STRING_TYPE)
             .label("User attribute form label")
-            .helpText("TODO")
+            .helpText("Message which will be displayed as user attribute input label. If value is a valid message key, then proper translation will be used.")
             .add()
 
             .property()
             .name(LOGIN_FORM_ERROR_MESSAGE)
             .type(ProviderConfigProperty.STRING_TYPE)
             .label("Validation error message")
-            .helpText("TODO")
+            .helpText("Message which will be displayed as user attribute validation error. If value is a valid message key, then proper translation will be used.")
             .add()
 
             .build();