Joomla OAuth Client Integration with ORCID Single Sign-On (SSO)
Integration of Orcid Single Sign-on (Orcid SSO) with Joomla using OAuth 2.0 Protocol. The miniOrange Joomla OAuth / OpenID Connect Single Sign-on (SSO) plugin makes it simple to set up Orcid SSO into Joomla and enable secure login into Joomla. As a result, users can log in to Joomla and access the site by authenticating with their Orcid OAuth provider credentials.
Visit our Joomla OAuth Client Plugin page to learn more about the features and Pricing plans we offer for the Joomla OAuth Single Sign-on (OAuth & OpenID connect) plugin.
Pre-requisites : Download And Installation
Steps to Install Joomla OAuth Client Plugin
- Download the zip file for the miniOrange OAuth Client plugin for Joomla.
- Login into your Joomla site’s administrator console.
- From left toggle menu, click on System, then under Install section click on Extension.
- Upload the downloaded zip file to install the Joomla OAuth Client plugin.
- Installation of the plugin is successful. Now click on Start Using miniOrange OAuth Client plugin.
- 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.
Setup Orchid as OAuth Provider with Joomla OAuth Client
1. Configure Callback/Redirect URL
- 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 Orchid as OAuth Server, then click on the Save & Next button.
- 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.
2. Configure Client ID and Secret
- Copy the Client ID and Client Secret then enter the Callback/Redirect URl which is copied in step1 under the redirect URIs.
- 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.
2.1. Scope & Endpoints
- Orcid Scope and Endpoints:
|
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)
|
3. Configure Attribute Mapping
- 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.
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.
4. 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.
Additional Resources
- What is OAuth 2.0?
- Frequently Asked Questions (FAQs)
- How to configure Oauth / OpenID Connect SSO with Azure AD
- How to configure Oauth / OpenID Connect SSO with Salesforce
- How to configure Oauth / OpenID Connect SSO with AWS Cognito SSO
- How to configure Oauth / OpenID Connect SSO with Discord
- How to configure Oauth / OpenID Connect SSO with Facebook
- How to configure Oauth / OpenID Connect SSO with Google Apps
- How to configure Oauth / OpenID Connect SSO with Instagram
- How to configure Oauth / OpenID Connect SSO with Keycloak
Mail us on joomlasupport@xecurify.com for quick guidance(via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.
Need Help? We are right here!
