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.
Joomla OAuth Client Handbook
Please refer our detailed Handbook for the Joomla OAuth/OpenID Single Sign-On plugin, which gives an in-depth explanation of the various features of the plugin. You can get to the handbook at anytime directly from the plugin's UI for quicker access.
Pre-requisites : Download And Installation
Setup Orchid as OAuth Provider with Joomla OAuth Client
1. Download and Setup Joomla OAuth Client
- Download the zip file for the miniOrange OAuth Client plugin for Joomla from the given link.
- Login into your Joomla site’s administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Upload the downloaded zip file to install the Joomla OAuth Client plugin.
- After successful installation of plugin, click on Start Using miniOrange OAuth Client plugin button.
- Copy the Callback/Redirect URL from Configure OAuth tab of Joomla OAuth Client plugin.
2. Configure Orchid as OAuth Provider
- First of all, 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.
- Your API credentials - Client ID and Client Secret - are shown just beneath your redirect URIs paste the Callback/Redirect URl which is copied from here. Below your credentials are sample URLs and API calls with your credentials pre-filled.
3. Integrating Joomla with Orchid
- Go back to your Joomla Dashboard. Then go to Components.
- Now go to the Joomla OAuth Client plugin, under Configure OAuth tab, enter the all the details. Then click on Save Settings and then click on Test Configuration.
Orcid Scope and Endpoints:
| Scope: | openid |
| Authorize endpoint: | https://orcid.org/oauth/authorize |
| Access Token endpoint: | https://orcid.org/oauth/token |
| Custom redirect URL after logout:[optional] | https://orcid.org/userStatus.json?logUserOut=true |
| Set Client Credentials: | In Both (In Header and In Body) |
4. Test SSO and Attribute Mapping
- Once you click on Test Configuration button, You will be able to see the attributes in the Test Configuration output as follows.
- Now you have to do Attribute Mapping to perform SSO. Select the attribute name for Email and Username from dropdown. Then click on Save Attribute Mapping button.
- Now you can use Login / SSO URL 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!
