Configure Keycloak Single Sign-On (SSO) with WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin. Enable secure login into WordPress using Keycloak as OAuth and OpenID Connect provider. Keycloak Single Sign-On (SSO) with WordPress allows your users to login to your WordPress and access the site by authenticating with their Keycloak identity provider. You can also configure plugin using different IDPs such as Azure AD, Office 365, and other custom providers. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, multi-tenant login etc. Here we will go through a guide to configure Keycloak Single Sign-On (SSO) with WordPress for user authentication. By the end of this guide, users should be able to perform secure login to WordPress and access the site with Keycloak SSO. To know more about other features we provide in WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin, you can click here.

Pre-requisites : Download And Installation

• Log into your WordPress instance as an admin.
• Go to the WordPress Dashboard -> Plugins and click on Add New.
• Search for a WordPress OAuth Single Sign-On (SSO) plugin and click on Install Now.
• Once installed click on Activate.

Steps to configure Keycloak Single Sign-On (SSO) Login into WordPress

1. Setup Keycloak as OAuth Provider

• First of all, Download Keycloak and install it.
• Start Server: Start the keycloak server by running the _standalone.sh_ file.
Root Directory of keycloak bin standalone.sh
• Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Add Realm option.

• Create realm: Enter Realm Name and keep the realm name handy as it will required later to configure the Realm under the OAuth Client plugin. Click on CREATE to add realm.

• Create OpenID client: Click on the Clients and choose create to create a new client. Enter client id and select client protocol openeid-connect and select Save.

• Change Access type: After client is created change its access type to confidential.

• Enter Valid Redirect URIs: Copy callback URL from plugin and then click on SAVE. Ex -- https:///oauth/callback

• Get Client Secret: Now we need to get client secret. So select Clients and select credentials and copy your secret from here.

• Plugin Configuration: Enter copied Client Secret under Client secret field in the OAuth Client plugin, and enter the Client Name under the Client ID field.
• Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and choose to Add a new User.

• User Configuration: After user is created following action needs to be performed on it.
1) Setting a password for it so click on Credentials and set a new Password for the user.



NOTE : Disabling Temporary will make user password permanent.

• Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles and clicking on add selected.

• Create ROLE: The Role will be used by your applications to define which users will be authorized to access the application. Click on the Roles and choose Add Role.


Step 1.1: Steps to fetch the Group mapper [Premium]

• Create groups: Click on the Groups and choose New to create a new group.

• Assign user to group: Select the user whom you want to add in group. Choose Groups option from tab and then select the group-name and click on join.

• Keycloak Group Mapper: Now to get group details we need to perform its client mapping with group membership else group details will not be fetched. So in Client section, select your client and then click on mapper->create.

• Now, select mapper type as Group Membership and enter the name and token claim name i.e the attribute name corresponding to which groups will be fetched. Turn Off the full group path, Add to ID token and Add to access token options, and click on Save.


Note: -- If full path is on group path will be fetched else group name will be fetched.

Step 1.2: Steps to fetch the Role mapper [Premium]

• Keycloak Role Mapper: Now to get role details we need to perform its client mapping with role membership else role details will not be fetched. So in Client section, select your client and then click on mapper->create.

• Now, select mapper type as user realm Role Membership and enter the name. and token claim name i.e the attribute name corresponding to which groups will be fetched. Add to ID token and Add to access token options, and click on Save.

You have successfully configured Keycloak as OAuth Provider for achieving Keycloak Single Sign-On (SSO) with WordPress for user authentication.

2. Setup WordPress as OAuth Client

3. User Attribute Mapping

• User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.

Finding user attributes

• Go to Configure OAuth tab. Scroll down and click on Test Configuration.

• You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.

• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.

4. Role Mapping [Premium]

• Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
• From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.

• Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
  Eg: Role


• Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.
  
  For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.

• Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
  Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

5. Sign In Settings

• The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Keycloak login widget on your WordPress page, you need to follow the below steps.

Sign in settings for WordPress 5.7 and before

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.


Sign in settings for WordPress 5.8

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.

• Open your WordPress page and you can see the Keycloak SSO login button there. You can test the Keycloak Single Sign-On (SSO) now.

Sign in settings for WordPress 5.9

• Make sure the "Show on login page" option is enabled for your application. (Refer to the below image)

• Now, go to your WordPress Login page. (Eg. https://< your-wordpress-domain >/wp-login.php)
• You will see an Keycloak SSO login button there. Once you click the login button, you will be able to test the Keycloak Single Sign-On (SSO).