WordPress User Sync for Keycloak | Sync Users from WordPress to Keycloak
WP Remote User Sync plugin provides Automated user synchronization from WordPress to Keycloak. The WordPress User Sync plugin enables real-time user data synchronization.
The WordPress User Sync plugin allows you to automate user creation, update and delete user information from WordPress in real-time to 3rd party applications and automate user sync.
Pre-requisite
To configure User Sync with Keycloak, you will need to install the miniOrange WP to Remote User Sync plugin:
WordPress User Sync plugin allows you to automate user provisioning (create, update and delete user information) from WordPress in real-time to 3rd party applications and automate user sync for WordPress from different IDPs.[24/7 SUPPORT]
Steps to Configure Keycloak:
- Go to your Keycloak realm (other than master) and select your client from the Clients tab (remote_sync in this case).
- Make sure to have the following Capability config enabled.
- In the Service accounts roles tab, Assign the initial required roles as shown below.
- Once you assign the initial roles, click on Assign role and then Filter by clients to assign additional roles which are required for API permissions.
- Go to your Keycloak client and copy the Client ID from the Settings tab. Next go to the Credentials tab and copy the Client Secret.
- Further, the configuration also requires the OpenID Endpoint which is available in the OpenID Endpoint Configuration under Realm Settings as shown below.
Steps to Configure WP Remote Sync plugin
- Activate the WP Remote Sync plugin and you’ll be directed to the main configuration page.
- Click on Add New Remote Server.
- Name the current configuration with a suitable name, then proceed to select Keycloak from the dropdown menu below.
- Once you have provided the configuration with a suitable name, paste the Client ID, Client Secret and OpenID Endpoint Configuration in their respective fields.
- Scroll down to and turn the Create User in Remote when User is created in WordPress toggle on and click on Save Configuration.
- Go to the Attribute Mapping tab and select the appropriate attribute to be mapped, as shown below.
- Save the configuration and click on Back to Remote Server List on the top and go to the Users section of WordPress.
- Now click on Add User to create a new user in WordPress. Once the user is created in WordPress, it will automatically be created in Keycloak.
- Instead of creating if you want to sync any of your existing users, you can select the users you want to sync from the list and select Sync Users to Remote Server from the Bulk Actions dropdown.
- To check if your users are synced into Keycloak, navigate to Keycloak (Keycloak realm) -> Users and you will see the users created there.
| Keycloak Attributes | WordPress Attributes |
| username | user_login |
| user_email | |
| firstName | first_name |
| lastName | last_name |
| password | user_pass |
You have successfully configured User Sync for your Keycloak users using the WP Remote Sync plugin.
Conclusion
WordPress Keycloak Integration with WP Remote User Sync allows you to automate WordPress user sync from WordPress to Keycloak. With this setup guide you have integrated WordPress user sync plugin to automate user creation, update and delete user information from WordPress in real-time to Keycloak and automate Keycloak user sync.
Additional Resources
Need Help? We are right here!
Need Help? We are right here!
