Orcid OAuth & OpenID connect Single Sign-On (SSO) | Orcid SSO Login

Steps to configure ORCID Single Sign-On (SSO) Login into WordPress

1. Setup ORCID as OAuth Provider

• Go to https://orcid.org/signin and 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. Below your credentials are sample URLs and API calls with your credentials pre-filled.

You have successfully configured ORCID as OAuth Provider for achieving ORCID login into your WordPress Site.

2. Setup WordPress as OAuth Client

• Free
• Premium

• Go to Configure OAuth tab and click Add New Application to add a new client application into your website.

• Choose your Application from the list of OAuth / OpenID Connect Providers, Here Orcid.

• Copy the Callback URL to be used in OAuth Provider Configuration and click Next.

• Configure App name & Domain found from the Okta SSO application. Click Next.
• Enter the client credentials like Client ID & Client Secret as shown in the setup dialogue box. openid is already filled. Click Next.

• Verify the configuration details and click on Finish to save the configuration.

• Go to Configure OAuth tab and search your application name to add a new client application into your website, Here Orcid.

• Configure App Name, Client ID, Client Secret, Domain from Orcid SSO application

• Choose your Grant Type from the list of options & Click on Save Settings to save the configuration.

You have successfully configured WordPress as OAuth Client for achieving Orcid login into your WordPress Site.

3. User Attribute Mapping

• User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.

Finding user attributes

• Go to Configure OAuth tab. Scroll down and click on Test Configuration.

• You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.

• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.


4. Role Mapping [Premium]

• Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
• From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.

• Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
  Eg: Role


• Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.
  
  For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.

• Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
  Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

5. Sign In Settings

• The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Orcid login widget on your WordPress page, you need to follow the below steps.

Sign in settings for WordPress 5.7 and before

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.


Sign in settings for WordPress 5.8

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.

• Open your WordPress page and you can see the Orcid SSO login button there. You can test the Orcid Single Sign-On (SSO) now.

Sign in settings for WordPress 5.9

• Make sure the "Show on login page" option is enabled for your application. (Refer to the below image)

• Now, go to your WordPress Login page. (Eg. https://< your-wordpress-domain >/wp-login.php)
• You will see an Orcid SSO login button there. Once you click the login button, you will be able to test the Orcid Single Sign-On (SSO).


6. Scope & Endpoints

Please refer the following table for configuring the scope & endpoints in the plugin.

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 this Guide, you have successfully configured ORCID Single Sign-On (SSO) by configuring ORCID as OAuth Provider and WordPress as OAuth Client using our WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin. This solution ensures that you are ready to roll out secure access to your WordPress site using ORCID login credentials within minutes.

Additional Resources

• Orcid as OAuth Provider / OpenID Connect
• Customize default login and registartion form of ORCID
• WordPress Single Sign-On (SSO) OAuth / OpenID Connect / JWT
• What is OAuth 2.0 and how does it work?
• Frequently Asked Questions (FAQs)

Need Help?

Mail us on oauthsupport@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.