Meet us at WordCamp Kerala 2024 Conference to explore solutions. Know More
WordPress Keycloak Single Sign On with Keycloak as IDP | WordPress Keycloak Login
Configure secured WordPress Keycloak Single Sign On (SSO) login using our WordPress(WP) SAML Single Sign-On(SSO) plugin. The WP SAML SSO plugin leverages the SAML 2.0 protocol to allow users to use their Keycloak credentials for a seamless WordPress Keycloak Login via SSO. Facilitating WordPress Keycloak SSO enables users to authenticate against their Keycloak credentials and securely access your WordPress site.
This step-by-step setup guide will help you configure Keycloak as Identity Provider (IDP) and WordPress as Service Provider (SP) to achieve WordPress Keycloak SSO. You can visit our WordPress SSO plugin to know more about the other features we provide.
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 WordPress Single Sign On (SSO) plugin and click on Install Now.
- Once installed click on Activate.
Steps to configure WordPress Keycloak Login using Keycloak as IDP
Select Keycloak version:
1. Setup Keycloak as IdP (Identity Provider)
Follow the following steps to configure Keycloak as IdP to achieve WordPress Keycloak SSO
Configure Keycloak as IdP
- In the miniOrange WordPress SAML SP SSO plugin, navigate to SP (Service Provider) Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the keycloak as IdP (Identity Provider).
- In your Keycloak Admin console, select the realm that you want to use.
- Click on Clients from the left menu and then click on Create button to create a new client/application.
- Enter SP-EntityID / Issuer as the Client ID from the "Service Provider Metadata" Tab and select SAML as the Client Protocol.
- Now click on Save.
- Configure Keycloak by providing the required details:
- Under Fine Grain SAML Endpoint Configuration, Enter the following details:
- Click on Save.
- In the miniOrange WordPress SAML SP SSO plugin, navigate to SP (Service Provider) Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the keycloak as IdP (Identity Provider).
- In your Keycloak Admin console, select the realm that you want to use.
- Click on Clients from the left menu and then click on Create Client button to create a new client/application.
- Select SAML as Client type, Enter SP-EntityID / Issuer as the Client ID from the "Service Provider Metadata" Tab,Enter Name of your application and enter Description.
- Now click on Save.
- Configure Keycloak by providing the required details:
- Now click on Save.
- In Advanced tab,under Fine Grain SAML Endpoint Configuration, Enter the following details:
- Click on Save.
- In the miniOrange WordPress SAML SP SSO plugin, navigate to SP (Service Provider) Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the keycloak as IdP (Identity Provider).
- In your Keycloak Admin console, select the realm that you want to use.
- Click on Clients from the left menu and then click on Create Client button to create a new client/application.
- Select SAML as Client type, Enter SP-EntityID / Issuer as the Client ID from the Service Provider Metadata tab, enter Name of your application and enter Description.
- Click on the Next button.
- Provide the details as mentioned below:
- Click on Save button.
- In the Settings tab under SAML capabilities section, configure Keycloak by providing the required details:
- In the Keys tab, disable the Client signature required toggle.
- Click on the Save button.
- In Advanced tab, under Fine Grain SAML Endpoint Configuration, enter the following details:
- Click on Save button.
| Client ID | The SP-EntityID / Issuer from the plugin's Service Provider Metadata tab |
| Name | Provide a name for this client |
| Description | Provide a description |
| Client Signature Required | OFF |
| Force POST Binding | OFF |
| Force Name ID Format | OFF |
| Name ID Format | |
| Root URL | Leave empty or Provide Base URL from Service Provider Metadata tab |
| Valid Redirect URIs | The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab |
| Assertion Consumer Service POST Binding URL | The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab |
| Logout Service Redirect Binding URL (Optional) | The Single Logout URL from the plugin's Service Provider Metadata tab |
| Client ID | The SP-EntityID / Issuer from the plugin's Service Provider Metadata tab |
| Name | Provide a name for this client |
| Description | Provide a description |
| Client Signature Required | OFF |
| Force POST Binding | OFF |
| Force Name ID Format | OFF |
| Name ID Format | |
| Root URL | Leave empty or Provide Base URL from Service Provider Metadata tab |
| Valid Redirect URIs | The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab |
| Assertion Consumer Service POST Binding URL | The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab |
| Logout Service Redirect Binding URL (Optional) | The Single Logout URL from the plugin's Service Provider Metadata tab |
| Root URL | Leave empty or provide Base URL from Service Provider Metadata tab |
| Valid Redirect URIs | The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab |
| Force POST Binding | OFF |
| Force Name ID Format | OFF |
| Name ID Format |
| Assertion Consumer Service POST Binding URL | The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab |
| Logout Service Redirect Binding URL (Optional) | The Single Logout URL from the plugin's Service Provider Metadata tab |
Add Mappers
- Navigate to Mappers tab and click on Add Builtin button.
- Select the checkboxes of X500 givenName, X500 surname and X500 email attributes.
- Click on Add Selected button. You will see the mappings that are added below.
- In Client scopes tab,click on your application.
-
Click on Add predefined mapper.
- Select the checkboxes of X500 givenName, X500 surname and X500 email attributes.
- Click on Add button.
- You will see the mappings that are added below.
- In the Client scopes tab, click on your application.
- Click on Add predefined mapper.
- Select the checkboxes of X500 givenName, X500 surname and X500 email attributes.
- Click on the Add button.
- You will see the mappings that are added below.
Download setup file
- Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tab.
- Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
- Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tab.
- Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
- Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General tab.
- Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
You have successfully configured Keycloak as SAML IdP ( Identity Provider) for achieving WordPress Kecloak SSO, ensuring secure Login into WordPress (WP) Site.
You have successfully configured Keycloak as SAML IdP ( Identity Provider) for achieving Keycloak login / Keycloak SSO / Keycloak Single Sign-On (SSO), ensuring secure Login into WordPress (WP) Site.
You have successfully configured Keycloak as SAML IdP ( Identity Provider) for achieving Keycloak login / Keycloak SSO / Keycloak Single Sign-On (SSO), ensuring secure Login into WordPress (WP) Site.
Note: If you intend to set up Attribute Mapping, Role Mapping, and other configurations on the Identity Provider's end, you can find detailed instructions in the provided setup guide, which is linked here.
2. Configuring WordPress as SP (Service Provider)
- Free
- Standard
- Premium
In the WordPress SAML SSO plugin, go to the Service Provider Setup tab of the plugin. There are two ways to configure the WordPress SSO plugin:
A. By uploading IDP metadata:
- Click on Upload IDP metadata button.
- Enter the Identity Provider Name
- You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.
B.Manual Configuration:
- Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.
- Click on Test configuration to check the attributes and values sent by IDP.
Step 3: Attribute Mapping
- In the free plugin, only NameID is supported for Email and Username attributes of the WordPress user.
- When a user performs SSO, the NameID value sent by the IDP will get mapped to the email and username of the WordPress user.
Step 4: Role Mapping
- In the free plugin, you can choose a Default Role which will be assigned to all the non-admin users when they perform SSO.
- Go to Attribute/Role mapping tab and navigate to Role Mapping section.
- Select the Default Role and click on the Update button.
Step 5: SSO settings
- In the free plugin you can add a Single Sign-On button by enabling Add a Single Sign-On button on the WordPress Login Page toggle in Option 1.
- If your WordPress theme supports login widget, you can add a login widget to enable SP-Initiated SSO on your site.
- Navigate to Redirection and SSO links tab and follow the given steps given under Option 2: Use a Widget to add a login widget on your site.
In the WordPress SAML SSO plugin, go to the Service Provider Setup tab of the plugin. There are two ways to configure the WordPress SSO plugin:
A. By uploading IDP metadata:
- Click on Upload IDP metadata button.
- Enter the Identity Provider Name
- You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.
B.Manual Configuration:
- Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.
- Click on Test configuration to check the attributes and values sent by IDP.
Step 3: Attribute Mapping
- Attribute Mapping feature allows you to map the user attributes sent by the IDP during SSO to the user attributes at WordPress.
- In WordPress SAML plugin, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.
NOTE: If you click on Test Configuration button in Service Provider Setup tab and authenticate with your IDP, you can see a list of attributes sent by the IDP in the Attribute/Role mapping tab. This information can be used to provide the above mapping.
Step 4: Role Mapping
- Go to Attribute/Role mapping tab and navigate to Role Mapping section.
- Select the Default Role and click on the Save button.
In the standard plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO.
Step 5: SSO settings
- Auto-Redirection from site: If this option is enabled, any unauthenticated user trying to access your site will get redirected to the IDP login page and after successful authentication, they will be redirected back to the same page on your site which they were trying to access.
- Go to Redirection and SSO Links tab of the plugin and navigate to Option 1: Auto - Redirection from site.
- Enable Redirect to IdP if user not logged in [PROTECT COMPLETE SITE]option.
- Auto-Redirection from WordPress Login: If this option is enabled, any unauthenticated user trying to access the default WordPress login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the WordPress site.
- Go to Redirection and SSO Links tab of the plugin and navigate to Option 2: Auto- Redirection from WordPress Login.
- Enable Redirect to IdP from WordPress Login Page option.
- SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Redirection and SSO Links tab > Option 3: SSO Links section of the plugin
In the Standard plugin you can enable SP-initiated SSO using the following options.
Steps:
Steps:
NOTE: Please enable the Backdoor login and note down the backdoor URL. This will allow you to access the WordPress login page in case you get locked out of the IDP.
In the WordPress SAML SSO plugin, go to the Service Provider Setup tab of the plugin. There are two ways to configure the WordPress SSO plugin:
A. By uploading IDP metadata:
- Click on Upload IDP metadata button.
- Enter the Identity Provider Name
- You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.
- In the Premium plugin, you can enable auto-sync for the metadata URL which will auto-update the plugin configuration as per the IDP metadata after a set interval of time
B.Manual Configuration:
- Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.
- Click on Test configuration to check the attributes and values sent by IDP.
- In the Premium Plugin, you can provide the SAML Logout URL to achieve Single Logout on your WordPress site.
Step 3: Attribute Mapping
- Attribute Mapping feature allows you to map the user attributes sent by the IDP during SSO to the user attributes at WordPress.
- In WordPress SAML plugin, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.
- Custom Attribute Mapping: This feature allows you to map any attribute sent by the IDP to the usermeta table of WordPress.
Step 4: Role Mapping
- From the Attribute Mapping section of the plugin, provide a mapping for the field named Group/Role. This attribute will contain the role related information sent by the IDP and will be used for Role Mapping.
- Navigate to role mapping section and provide the mappings for the highlighted roles.
- For example, If you want a user whose Group/Role attribute value is wp-editor to be assigned as an Editor in WordPress, just provide the mapping as wp-editor in the Editor field of Role Mapping section.
This feature allows you to assign and manage roles of the users when they perform SSO. Along with the default WordPress roles, this is compatible with any custom roles as well.
Step 5: SSO Settings
- Auto-Redirection from site: If this option is enabled, any unauthenticated user trying to access your site will get redirected to the IDP login page and after successful authentication they will be redirected back to the same page on your site which they were trying to access.
- Go to Redirection and SSO Links tab of the plugin and navigate to Option 1 : Auto-Redirection from site.
- Enable Redirect to IdP if user not logged in option.
- Auto-Redirection from WordPress Login: If this option is enabled, any unauthenticated user trying to access the default WordPress login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the WordPress site.
- Go to Redirection and SSO Links tab of the plugin and navigate to Option 2: Auto- Redirection from WordPress Login.
- Enable Redirect to IdP from WordPress Login Page option.
- Login Button: You can add a customized login button anywhere on your site or WordPress login page by navigating to Option 3: Login Button section of Redirection and SSO Links tab.
- SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Option 4: SSO Links section of Redirection and SSO Links tab.
In the Premium plugin you can enable SP-initiated SSO using the following options.
Steps:
Steps:
NOTE: Please enable the Backdoor login and note down the backdoor URL. This will allow you to access the WordPress login page in case you get locked out of the IDP login.
You have successfully configured WordPress (WP) as SAML SP for achieving WordPress Keycloak Single Sign On.
In this Guide, you have successfully configured Keycloak Single Sign-On (Keycloak WordPress SSO / WordPress Keycloak Login), choosing Keycloak as IdP and WordPress as SP. WordPress SAML Single Sign-On – SSO plugin solution ensures that you are ready to roll out secure access/login into WordPress (WP) site using Keycloak login credentials.
Recommended Add-Ons
SCIM User Provisioning
Allows syncing user's creation, updation and deletion from your IDP to WordPress site
Know more →
Page and Post Restriction
Restricts WordPress pages and posts based on User Roles and User's Login Status
Know more →
Learndash Integrator
Maps SSO users to LearnDash groups as per the group attributes sent by your IDP
Know more →Additional Resources
- SSO for WordPress Keycloak Login | Keycloak WordPress SSO [SAML]
- WordPress SSO for Educational Institutes
- What is Single Sign-On (SSO)?
- WooCommerce SSO Integration with Keycloak for User Sync
- Keycloak SSO Login
- What is SAML?
- Frequently Asked Questions (FAQs)
If you are looking for anything which you cannot find, please drop us an email on samlsupport@xecurify.com
Sign Up
Need Help? We are right here!
