Configure ORCID Single Sign-On (SSO) with Joomla OAuth Client Plugin
Overview
Single Sign-On (SSO) with ORCID in Joomla uses OAuth Authorization to provide users secure access to the Joomla
site. With our Joomla OAuth Single Sign-On (SSO) plugin, ORCID acts as the OAuth provider, ensuring secure login for
Joomla websites.
The integration of Joomla and ORCID simplifies and secures the login process using OAuth protocol. This solution
allows users to access their Joomla sites with Single Sign-On (SSO) using their ORCID credentials, completely
removing the need to store, remember, and reset multiple passwords.
In addition to offering OAuth Single Sign-On (SSO) using ORCID credentials, the plugin also provides advanced SSO
features like user profile attribute mapping, role mapping, and Azure multi-tenant login and providing site access
based on organization email domains. For further insights into the array of features we offer within the Joomla
OAuth & OpenID Connect Client plugin, kindly visit our page here. You can
follow the below steps to setup ORCID OAuth SSO with Joomla.
Configuration Steps
In this configuration, ORCID functions as the OAuth server, while Joomla allows users to log in with their ORCID credentials by utilizing the Joomla OAuth Client 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 ORCID as OAuth Server, then click on the Save & Next button.
Step 2: Configure ORCID as OAuth Server
- Log into your ORCID account.
- Click Developer Tools at the top of your record.
- Click the "Register for the free ORCID public API" button
- Review and agree to the terms of service when prompted.
- After agreeing to the terms of service, you will be directed back to Developer Tools. Complete the form presented to register a new application.
- Click the Save icon at the bottom of the form to generate your API credentials.
- To view your API credentials, click Show Details.
Step 3: Configure Client ID & Secret
- Copy your Client ID and Client Secret.
- Go to the Step 2 [Client ID & Secret] tab of the Joomla OAuth Client plugin, here paste the Client ID & Client Secret. Click on the Save Configuration button.
- Copy the Client ID and Client Secret then enter the Callback/Redirect URl which is copied in step1 under the redirect URIs.
- Scope & Endpoints are given below, which are required for configuring Joomla as OAuth Client plugin to configure ORCHID as a custom OAuth or OIDC provider.
| Scope | openid |
| Authorize Endpoint: | https://orcid.org/oauth/authorize |
| Access Token Endpoint: | https://orcid.org/oauth/token |
| Get User Info Endpoint: | https://orcid.org/userStatus.json?logUserOut=true |
| Set Client Credentials: | In Both (In Header and In Body) |
Step 4: Configure Attribute Mapping
- User Attribute Mapping is mandatory for enabling users to successfully login into Joomla. We will be setting up user profile attributes for Joomla using below settings.
- Go to Step 3 [Attribute Mapping] tab and click on Test Configuration button.
- You will be able to see the attributes in the Test Configuration output as follows.
- Now go to the Step 3 [Attribute Mapping] tab and Select the attribute name for Email and Username from dropdown. Then click on Finish Configuration button.
Step 5: Setup Login/SSO URL
- Now go to Step 4 [SSO URL] tab, here copy the Login/SSO URL and add it to your Site by following the given steps.
- Now logout and go to your Joomla site's pages where you have added this link. You will see a login link where you placed that button. Click on this button to perform SSO.
