Chapter 4. Custom user attributes

Procedure

1. Copy the template themes/base/login/register.ftl to the login type of your custom theme.

2. Open the copy in an editor.

   For example, to add a mobile number to the registration page, add the following snippet to the form:

   <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" value="${(register.formData['user.attributes.mobile']!'')}"/>
      </div>
   </div>

3. Ensure the name of the input html element starts with user.attributes. In the example above, the attribute will be stored by Red Hat build of Keycloak with the name mobile.
4. To see the changes, make sure your realm is using your custom theme for the login theme and open the registration page.