Skip to content

Commit 28114b8

Browse files
committed
Added configuration descriptions
1 parent 8a809f6 commit 28114b8

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

src/main/java/io/github/kilmajster/keycloak/UsernamePasswordAttributeFormConfiguration.java

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,40 @@ public interface UsernamePasswordAttributeFormConfiguration {
2121
.name(LOGIN_FORM_USER_ATTRIBUTE)
2222
.type(ProviderConfigProperty.STRING_TYPE)
2323
.label("User attribute")
24-
.helpText("TODO")
24+
.helpText("Attribute used to validate login form.")
2525
.add()
2626

2727
.property()
2828
.name(LOGIN_FORM_GENERATE_LABEL)
2929
.type(ProviderConfigProperty.BOOLEAN_TYPE)
3030
.label("Generate label")
3131
.defaultValue("true") // only string value is accepted
32-
.helpText("TODO")
32+
.helpText("If enabled, label for login form will be generated based on attribute name, so attribute with name:" +
33+
" \"foot_size\" will be labeled as \"Foot size\", \"REALLY_custom.user-Attribute\" will be translated " +
34+
"to \"Really custom user attribute\", etc. By default, set to true. If User attribute form label " +
35+
"is configured, label is taken form configuration and generation is skipped.")
3336
.add()
3437

3538
.property()
3639
.name(CLEAR_USER_ON_ATTRIBUTE_VALIDATION_FAIL)
3740
.type(ProviderConfigProperty.BOOLEAN_TYPE)
3841
.label("Clear user on validation fail")
3942
.defaultValue("true") // only string value is accepted
40-
.helpText("TODO")
43+
.helpText("If enabled, user is not stored in session context in case username and password were valid but user attribute was not.")
4144
.add()
4245

4346
.property()
4447
.name(LOGIN_FORM_ATTRIBUTE_LABEL)
4548
.type(ProviderConfigProperty.STRING_TYPE)
4649
.label("User attribute form label")
47-
.helpText("TODO")
50+
.helpText("Message which will be displayed as user attribute input label. If value is a valid message key, then proper translation will be used.")
4851
.add()
4952

5053
.property()
5154
.name(LOGIN_FORM_ERROR_MESSAGE)
5255
.type(ProviderConfigProperty.STRING_TYPE)
5356
.label("Validation error message")
54-
.helpText("TODO")
57+
.helpText("Message which will be displayed as user attribute validation error. If value is a valid message key, then proper translation will be used.")
5558
.add()
5659

5760
.build();

0 commit comments

Comments
 (0)