A simple example of creating custom User Federation module for keycloak. Tested on KeyCloak 11.0.2 with Java 8.
- Can connect with existing database in any database (as long JDBC can connect to it)
- Using Email as Login-name
- Enter query to get password in existing database, based on email
- Enter query to get several user attribute in existing database, based on email
- Edit the "keycloak.version" properties to the keycloak version you are using. In this example we use version 11.0.2
- Use mvn package to build the module into jar file
mvn package
- Add new jdbc driver and datasource in KeyCloak's Wildfly. For mysql, you can follow these configuration example: https://www.tutorialsbuddy.com/keycloak-mysql-setup
- Put the .jar file into standalone/deployments folder of keycloak. And then start/restart keycloak
- Goto your realm, and then choose User Federation
- Choose Add Provider, and select "Federation DB Provider"
- Configure these mandatory settings:
- Database JNDI name: The JNDI name of the datasource you want to use (example: java:jboss/datasources/UserDS)
- Query to Get Password by Email: The query used to get password from the table. Only one column permitted(example: select password from wp_users where email=?)
- Query to Get User Data: Query to get the user data to be imported to keycloak. Only two columns permitted and the name have to be email and firstName (example:select email,nama as firstName from wp_users where email=?)
- Klik save
- We are done, you can try to login in the realm's client with username/password from existing DB
You can freely posted any qeustions about this repository on this medium blog.
For feedback, please raise issues in the issue section of the repository. Periodically, I will update the code. Enjoy!!.
