Setup ORCID Single Sign-on with Drupal OAuth Client
Overview
Drupal miniOrange SSO integration will allow you to configure Single Sign-On ( SSO ) login between your Drupal site and ORCID using OAuth/OpenID protocol. Drupal OAuth 2.0/OpenID connect module gives the ability to enable login using OAuth 2.0/OIDC Single Sign-On to Drupal Site. We provide the Drupal OAuth/OpenID Client module for Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11.
Installation Steps
- Using Composer
- Using Drush
- Manual Installation
Configuration Steps
Setup Drupal as OAuth Client
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Custom OAuth 2.0 Provider from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy.
- Enter the application name in the Display Name text field. For example, ORCID.
Note: If your provider only supports HTTPS Callback/Redirect URLs and you have an HTTP site, please make sure to enable the 'Enforce HTTPS Callback URL' checkbox at the bottom of the tab.
Create Application in ORCID
- First of all, login into your ORCID admin 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.
Integrating Drupal with ORCID
- To view your API credentials, click Show Details.
- Your API credentials - Client ID and Client Secret - are shown just beneath your redirect URIs. Below your credentials are sample URLs and API calls with your credentials pre-filled.
- ORCID 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 |
- In Drupal’s Configure OAuth tab and paste the copied Client ID and Client Secret (copied from the ORCID) in the Client ID and Client Secret text-field.
Test Configuration of Drupal with ORCID
- Navigate to the Drupal site and click on the Perform Test Configuration button.
- On a Test Configuration popup, if you don't have an active session in ORCID on the same browser, you'll be prompted to sign in to ORCID. Once successfully logged in, you'll receive a list of attributes retrieved from ORCID.
- Scroll down and click on the Configure Attribute / Role Mapping button.
- On the Attribute & Role Mapping tab, please select the attribute under which the email of the user is received from the Email Address drop-down menu. Similarly, you can select the suitable option from the Name Attribute drop-down menu.
Note: Mapping the Email Attribute is mandatory for your login to work.
- Now log out and go to your Drupal site’s login page. You will automatically find a Login with ORCID link there. If you want to add the SSO link to other pages as well, please follow the steps given in the image below :
Need Assistance?
If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.
Additional Features:
Troubleshooting:
More FAQs ➔Getting error: 'Username not received. Check your
Attribute Mapping configuration.' OR Getting Error: 'Email not received. Check your Attribute Mapping
configuration.' 
Follow the steps mentioned HERE
I am getting "Client Credentials were not found in
the headers or body"
when I try to perform test configuration
Follow the steps mentioned HERE
After I click on the logout in Drupal, it sends me back to
the Drupal homepage. However, when I try to login with other user, it doesn't ask me to login but
automatically logs me in with same user
The logout functionality you've mentioned here is the default behavior of a module. It's logging you out of Drupal but not from your Application/Provider. To allow the module to logout from your provider/application account (what you are looking for), you need to make the below configurations: [know more]
I purchased the paid Drupal module and replaced it with
the free module, but still I am not able to use paid features.
As you have upgraded to one of our paid versions of the Drupal module and replaced the free module with the paid one, you must first activate the paid module. Please refer to the below steps. [Know more]
Contact us
