guide to configure/connect custom OpenID server to joomla

miniOrange Joomla OAuth/OpenID plugin gives the ability to enable OAuth/OpenID Single Sign On for Joomla site. Joomla OAuth Client plugin is compatible with all OAuth/OpenID Providers. Here we will go through a guide to configure SSO between Joomla and Generic OAuth Server. By the end of this guide, Generic OAuth Server users should be able to login and register to Joomla site.
If you have any doubts or queries you can contact us at joomlasupport@xecurify.com. We will help you to configure the plugin.

Step 1: Install Joomla OAuth Client Plugin

Login into your Joomla site’s Administrator console.
From left toggle menu, click on System, then under Install section click on Extensions.
Now click on Or Browse for file button to locate and install the plugin file downloaded earlier.
Installation of plugin is successful. Now click on Get Started!
Under Configure OAuth -> Pre-Configured Apps tab, select your OAuth Provider. You can also search for custom OAuth or custom OpenID application in the search bar, and configure your own custom provider.

After selecting your OAuth provider, you will be redirected to the Step 1 [Redirect URL] tab. Now copy the Callback/Redirect URL which we will use to configure Microsoft Entra ID as OAuth Server, then click on the Save & Next button.

Step 2: miniOrange Joomla OAuth Client plugin - Callback URL

Go to Components miniOrange OAuth Client in the top navigation bar to go to the configuration page of the plugin.

In the Configure OAuth tab, select your OAuth/OpenID Connect provider. If your OAuth/OpenID Connect provider is not listed, you can select Custom OAuth/OpenID Connect provider to continue.

Joomla OAuth Client Plugin - Configure OAuth

Copy the Redirect/Callback URL given in the plugin and keep it handy because you will need it in the next step.

Joomla OAuth Client - Test Configuration

Step 3: Configure general OpenID Server as an OpenID Connect Server.

Goto Configure OAuth tab.
Scroll Down and select Custom OpenID connect App.

Copy the Redirect / Callback URL and provide it to your Server.

You will be receiving the ClientID and Client Secret key from the Server please copy them and paste into the Client ID and Client Secret key fields provided in the Joomla OAuth Client plugin.

Joomla OAuth OpenID ClientID Client Secret key

Please fill the Scope to retrieve relevant information from the OpenID server

Please fill the Authorize Endpoint and Access Token Endpoint fields in the Joomla OAuth Client plugin which are available from your Server

Once configuration is done please click on Save Settings
On you save the configuration please click on the Test configuration to get the information related to you from the Server

Please fill the Attribute Mapping section using the details received during the Test Configuration to perform SSO.

Step 1: Install Joomla OAuth Client Plugin

Step 2: miniOrange Joomla OAuth Client plugin - Callback URL

Step 3: Configure general OpenID Server as an OpenID Connect Server.

Contents