keycloak-scim/server_development/topics/custom-attributes.adoc
Javier Pena f5b1f9b7bc ?html is not allowed when auto-escaping is on
Keycloak v.4.6.0
Caused by: freemarker.core.ParseException: Syntax error in template "account.ftl" in line 66, column 143:                           
Using ?html (legacy escaping) is not allowed when auto-escaping is on with a markup output format (HTML), to avoid double-escaping m
istakes
2018-11-19 11:40:52 -06:00

49 lines
2 KiB
Text

[[_custom_user_attributes]]
== Custom User Attributes
You can add custom user attributes to the registration page and account management console with a custom theme. This chapter describes how to add attributes
to a custom theme, but you should refer to the <<_themes,Themes>> chapter on how to create a custom theme.
=== Registration Page
To be able to enter custom attributes in the registration page copy the template `themes/base/login/register.ftl` to the login type of your custom theme. Then
open the copy in an editor.
As an example to add a mobile number to the registration page add the following snippet to the form:
[source,html]
----
<div class="form-group">
<div class="${properties.kcLabelWrapperClass!}">
<label for="user.attributes.mobile" class="${properties.kcLabelClass!}">Mobile number</label>
</div>
<div class="${properties.kcInputWrapperClass!}">
<input type="text" class="${properties.kcInputClass!}" id="user.attributes.mobile" name="user.attributes.mobile"/>
</div>
</div>
----
To see the changes make sure your realm is using your custom theme for the login theme and open the registration page.
=== Account Management Console
To be able to manage custom attributes in the user profile page in the account management console copy the template `themes/base/account/account.ftl` to the
account type of your custom theme. Then open the copy in an editor.
As an example to add a mobile number to the account page add the following snippet to the form:
[source,html]
----
<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!'')}"/>
</div>
</div>
----
To see the changes make sure your realm is using your custom theme for the account theme and open the user profile page in the account management console.