Skip to main content

How to add custom user attributes in keycloak and access them in spring boot application

Sometime it may be possible you want to add more parameters to standard registration page of keyloak for your users and aaccess that data in your spring boot application. This artical will show step by steps on how to add such extra attributes.

What is Keycloak

Keycloak is an open source software product to allow single sign-on with Identity Management and Access Management aimed at modern applications and services, to learn more visit

What is Spring boot

Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "just run". To learn more visit

To add an extra attribute in keyclkoak server you will need to edit actuall html template and then registaer new attribute in json response so that it will be available on client.

Edit HTML template

Lets assume we want to add mobile number on default registration page.

  • Go to Keycloak home installation directory
  • edit file theme/base/login/register.ftl
  • add following html in this file wherever you want to see mobile number field on the above screen.

  • Note down id="" for input tag, this is the field name for custom attribute which will be saved with user data

Edit Settings in KeyCloak Admin Panel

Now we need to map this field to rest service ourput, so that each client can access it.

  • Login to your KeyCloak admin panel
  • Select Your realm which you may have created already
  • Select Client which you may have created already from left side menu
  • Select Mapper tab

  • Click on create button on right
  • Enter Name as "Mobile Attirbute Mapping" (basically any name which you want to)
  • Select Mapper Type as "User Attribute" 
  • Add User Attribute as "mobile" , which is from html input tag id ""
  • Add Token Claim name as "mobile" or any other valid Json name field value, which you will read as json element in Spring boot application.
  • Select Claim Json Type as "String"
  • Click Save

Read Custom user attribute in Java/Spring boot

Say you have a controller like this 

Note line 13 , we are reading "mobile" from map , which is same as "Token Claim" set in mapper definition.


Popular posts from this blog

How to create java maven project in intelij

Open intellijCreate a new java maven project in intellij.

Select Maven type, Select JDK you want to use and click Next.
Enter GroupId and ArtifactId, click Next
Select project Location and click finish

Intelij will display a warning, just press Ok.

Once project is created , a popup may appear asking for auto import, select "Enable Auto Import" You will have a project created, looking something like this
Note: I have created these instructions using, Instruction for other OS or intellij Version shouldn't be much different, if you need instruction for other version leave a comment and i will try to come up with another set of instructions.
Intellij 2017.2.1 Java 1.8 Mac OS

How to create Spring boot cloud config server

What is Spring boot cloud config server?Spring Cloud Config Server provides an HTTP resource-based API for external configuration (name-value pairs or equivalent YAML content). The server is embeddable in a Spring Boot application, by using the @EnableConfigServer annotation. Consequently, the following application is a config server
In Simple terms, Spring boot cloud config server takes your application.yml or from your spring boot application and serve it over HTTP, and spring application which need to use it just need to delete the application.yml or and create one bootstrap.yml/properties and defined 2 simple properties and

Create New java project using one of following instructions.Create project with Java, maven and Intellij
Edit POM.xml, add following content in pom.xmlFirst specify the packaging
also add parent of this pom to be
NOTE: You can lookup the latest version for parent from h…