115 lines
3.2 KiB
Text
Executable file
115 lines
3.2 KiB
Text
Executable file
== Custom User Attributes
|
|
|
|
If you have custom user data you want to store and manage in the admin console, registration page, and user account service, you can easily add support for it by extending and modifying various Keycloak <<_themes,themes>>.
|
|
|
|
=== In admin console
|
|
|
|
To be able to enter custom attributes in the admin console, take the following steps
|
|
|
|
|
|
|
|
. themes/mytheme/admin
|
|
+`mytheme`
|
|
. theme.properties
|
|
+
|
|
[source]
|
|
----
|
|
parent=keycloak
|
|
import=common/keycloak
|
|
----
|
|
|
|
. themes/base/admin/resources/partials/user-attributes.html
|
|
+`themes/mytheme/admin/resources/partials/user-attributes.html`
|
|
. user-attributes.html
|
|
+
|
|
[source]
|
|
----
|
|
<div class="form-group clearfix block">
|
|
<label class="col-sm-2 control-label" for="mobile">Mobile</label>
|
|
<div class="col-sm-6">
|
|
<input ng-model="user.attributes.mobile" class="form-control" type="text" name="mobile" id="mobile" />
|
|
</div>
|
|
<span tooltip-placement="right" tooltip="Mobile number." class="fa fa-info-circle"></span>
|
|
</div>
|
|
----
|
|
+`ng-model`
|
|
+`user.attributes.ATTR_NAME`
|
|
. Change the theme for the admin console. Save it, then refresh your browser, and you should
|
|
now see these fields in the User detail page for any user.
|
|
|
|
=== In registration page
|
|
|
|
To be able to enter custom attributes in the registration page, take the following steps
|
|
|
|
|
|
|
|
. themes/mytheme/login
|
|
+`mytheme`
|
|
. theme.properties
|
|
+
|
|
[source]
|
|
----
|
|
parent=keycloak
|
|
import=common/keycloak
|
|
styles= ../patternfly/lib/patternfly/css/patternfly.css ../patternfly/css/login.css ../patternfly/lib/zocial/zocial.css css/login.css
|
|
----
|
|
|
|
. themes/base/login/register.ftl
|
|
+`themes/mytheme/login/register.ftl`
|
|
. register.ftl
|
|
+
|
|
[source]
|
|
----
|
|
|
|
<div class="form-group">
|
|
<div class="${properties.kcLabelWrapperClass!}">
|
|
<label for="user.attributes.mobile" class="${properties.kcLabelClass!}">Mobile number</label>
|
|
</div>
|
|
|
|
<div class="col-sm-10 col-md-10">
|
|
<input type="text" class="${properties.kcInputClass!}" id="user.attributes.mobile" name="user.attributes.mobile"/>
|
|
</div>
|
|
</div>
|
|
----
|
|
+`user.attributes.ATTR_NAME`
|
|
. Change the theme for the login to your new theme. Save it, then refresh your browser, and you should
|
|
now see these fields in the registration.
|
|
|
|
=== In user account profile page
|
|
|
|
To be able to manage custom attributes in the user account profile page, take the following steps
|
|
|
|
|
|
|
|
. themes/mytheme/account
|
|
+`mytheme`
|
|
. theme.properties
|
|
+
|
|
[source]
|
|
----
|
|
parent=patternfly
|
|
import=common/keycloak
|
|
|
|
styles= ../patternfly/lib/patternfly/css/patternfly.css ../patternfly/css/account.css css/account.css
|
|
----
|
|
|
|
. themes/base/account/account.ftl
|
|
+`themes/mytheme/account/account.ftl`
|
|
. account.ftl
|
|
+
|
|
[source]
|
|
----
|
|
|
|
<div class="form-group">
|
|
<div class="col-sm-2 col-md-2">
|
|
<label for="user.attributes.mobile" class="control-label">Mobile number</label>
|
|
</div>
|
|
|
|
<div class="col-sm-10 col-md-10">
|
|
<input type="text" class="form-control" id="user.attributes.mobile" name="user.attributes.mobile" value="${(account.attributes.mobile!'')?html}"/>
|
|
</div>
|
|
</div>
|
|
----
|
|
+`user.attributes.ATTR_NAME`
|
|
. Change the theme for the account to your new theme. Save it, then refresh your browser, and you should
|
|
now see these fields in the account profile page.
|