JBoss Keycloak SAML Single Sign-On (SSO) into Joomla
miniOrange Joomla SAML SP SSO plugin helps you to integrate your Joomla site to Keycloak using SAML 2.0 protocol. The miniOrange Joomla SAML SP Single Sign-on (SSO) plugin is simple to set up Jboss Keycloak SSO into Joomla and enable secure login into Joomla. As a result, users can access multiple Joomla applications with one login after authenticating with their Keycloak IDP credentials.
Our plugin is compatible with Joomla 4 as well as with all the SAML 2.0 compliant Identity Providers.Here we will go through a step-by-step guide to configure SAML SSO login between the Joomla site and Keycloak by considering Keycloak as IDP (Identity Provider) & Joomla as SP (Service Provider).
What is SSO ?
Download of Plugin
Joomla SAML Handbook
This detailed Handbook for the Joomla SAML SP Single Sign On plugin gives an in-depth explanation of the features of the plugin.
Configuration Support and Free Trial
If you want any assistance or support while configuring a plugin or integrating Jboss Keycloak with Joomla, then click on the Free Configuration Setup button.
We provide a 7-day full feature trial of our license version of the plugin where you can thoroughly test out all the features of the plugin on your site. Click on the Free Business Trial button if you want us to set up the trial for you.
Steps to Integrate Okta Single Sign-On (SSO) with Joomla SAML SP
1. Download and setup Joomla SAML SP Plugin
- Download the zip file for the miniOrange SAML SP plugin for Joomla from the link here.
- Login into your Joomla site’s Administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Here click on Browse for file button to locate and install the plugin file downloaded earlier.
- Installation of plugin is successful. Now click on Start Using miniOrange SAML SP plugin.
- Then go to the Service Provider Metadata Tab, scroll down and copy the SP-EntityID and the ACS URL.
2. Configure Jboss Keycloak as IdP
- In your Keycloak admin console, select the realm that you want to use.
- Click on the Clients from the left navigation bar.
- Click on create client and enter the following values to create a client.
Client ID SP-EntityID/Issuer from Service Provider Metadata - Click on Save.
- Configure the following:
Client ID The SP-EntityID / Issuer from Service Provider Metadata Name Provide a name for this client (Eg. Joomla) Description (optional) Provide a description Enabled ON Consent Required OFF Client Protocol SAML Include AuthnStatement NO Sign Documents NO Optimize Redirect signing key lookup OFF Sign Assertions NO Signature Algorithm RSA_SHA256 Encrypt Assertion OFF Client Signature Required OFF Client Signature Required EXCLUSIVE Force Name ID Format NO Name ID Format Email Root URL Leave empty or Base URL of Service Provider Valid Redirect URIs The ACS (Assertion Consumer Service) URL from Service Provider Metadata - Under Advanced -> Fine Grain SAML Endpoint Configuration, configure the following:
Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from Service Provider Metadata Logout Service Redirect Binding URL The Single Logout URL from Service Provider Metadata 
- Click on Save.
Add Mappers
- Go to the Mappers tab, and click on Add predefined mapper.
Add User
- Click on the Users from the left nav bar.
- Add a crteate New users.
- Enter the username, valid email address and check on User Enabled then enter First name & Last name.
- Click on Create button.
- Click on the Realm Settings from the left nav bar and open SAML 2.0 Identity Provider Metadata.
- Go to, https://<YOUR_DOMAIN>/auth/realms/{YOUR_REALM}/protocol/saml/descriptor.These will open an XML in the browser.
- In miniOrange’s Joomla SAML SP plugin, go to Service Provider Setup Tab. Enter the following values:
OR
| Identity Provider Name | Provide an Identity Provider name (For Example: Keycloak). |
| IdP Entity ID or Issuer | Search for the entityID from IDP Metadata.Enter the Value in the Entity ID textbox. |
| SAML Login URL | Search for SingleSignOnService Binding ”urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect” from IDP Metadata.Enter the location value in the SAML Login URL textbox. |
| SAML Logout URL (Optional) | Search for SingleLogoutService Binding”urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect” from IDP Metadata.Enter the location value in the SAML Login URL textbox. |
| X.509 Certificate (Optional) | Search for the X.509 Certificate from IDP Metadata.Enter the tag value in Certificate textbox. |
| Enable login with SAML | Checked |
| Signed SSO and SLO Requests | Unchecked |
- In your Keycloak admin console, select the realm that you want to use.
- Click on Clients from the left menu and then click on Import client .
- Go to service provider Metadata tab and Download the XML File.
- Click on Browse tab,then Enter Name description (as per your choice)then click on save button.
- Go to Client scope and recently added Client scope .
- Go to the Mappers tab, and click on Add predefined mapper.
- Click the mappers as shown in click on Add Button.
- Click on Realm setting from the left menu and then click on Saml 2.0 Identity Provider Metadata.
- Copy The URL,and Navigate back to miniorange SAML Plugin and go to service Provider setup tab,then click on Upload Metadata file and paste on enter metadata Url and Click on Fetch Metadata.
3. Configure Joomla as Service Provider
In Joomla SAML plugin, go to Service Provider Setup Tab. There are three ways to configure the plugin:
- Click on Upload IDP Metadata.
- Enter Metadata URL (Copy from IDP app) and click on Fetch Metadata.
- Click on Upload IDP Metadata.
- Choose metadata file and click on Upload.
- Copy SAML Entity ID, SAML Single-Sign-On Endpoint URL and x.509 certificate from
Federation Metadata document and paste it in IdP Entity ID or Issuer, Single Sign-on Service
URL, x.509 Certificate fields respectively in the plugin.
By Metadata URL :
By Uploading Metadata
File:
Manual Configuration
:
| IdP Entity ID or Issuer | SAML Entity ID in the Federation Metadata document |
| Single Sign-On Service URL | SAML Single-Sign-On Endpoint URL in the Federation Metadata document |
| X.509 Certificate | x.509 Certificate in the Federation Metadata document |
Add a button on your site
login page with the following URL:
4. Attribute Mapping (It is Optional to fill this). This is Premium feature.
- Attributes are user details that are stored in your Identity Provider.
- Attribute Mapping helps you to get user attributes from your Identity Provider (IdP) and map them to Joomla user attributes like firstname, lastname etc.
- While auto registering the users in your Joomla site these attributes will automatically get mapped to your Joomla user details.
- In Joomla SAML plugin, go to Attribute Mapping tab and fill in all the fields.
Username: Name of the username attribute from IdP (Keep NameID by default) Email: Name of the email attribute from IdP (Keep NameID by default) Group/Role: Name of the Role attribute from Identity Provider(IdP) - You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.
5. Group Mapping (It is Optional to fill this). This is Premium feature.
- Role mapping helps you to assign specific roles to users of a certain group in your Identity Provider (IdP).
- While auto registering, the users are assigned roles based on the group they are mapped to.
6. Redirection & SSO Links
- Go to Login Settings tab. There are multiple features availabe in this tab like Auto redirect the user to Identity Provider and Enable Backed Login for Super Users. To use these features, click on the respective checkboxes.
You have successfully completed your miniOrange SAML 2.0 SP configurations. Still, if you are facing any difficulty please mail us on joomlasupport@xecurify.com .
Recommended Add-Ons
User Sync SCIM Provisioning
Synchronize users, groups & directory with SCIM & REST APIs for Server.
Know More
Page Restriction
Page Restriction plugin restricts Joomla pages (Articles) based on User Roles and User's Login Status.
Know More
Integrate with Community Builder Customer
Using this Add-on you would be mapping the user details into the CB's comprofilers fields table which contains the values.
Know More
Additional Resources.
- What is Single Sign-On (SSO)
- How to configure SSO with Okta
- How to configure SSO with Google Apps
- Frequently Asked Questions (FAQs)
miniorange Joomla SAML Single sign-on(web SSO) supports multiple known IDPs like WSO2, Azure AD, Salesforce,
Shibboleth, Onelogin, Okta, SimpleSamlPhp, Google apps, Bitium, OpenAM, miniorange IDP, Centrify and many more.
Business Trial
If you want Business Trial for FREE Click Here
If you don't find what you are looking for, please contact us at joomlasupport@xecurify.com or call us at +1 978 658 9387.
Need Help? We are right here!
