Open edX eduNEXT OAuth and OpenID connect Single Sign-On (SSO) Login

Steps to configure Open edX eduNEXT Single Sign-On (SSO) Login into WordPress

1. Setup Open edX eduNEXT as OAuth Provider

• Go to developer account of Open edX eduNEXT and sign up/login.
• From Configure OAuth tab in Oauth Client plugin, collect Redirect/Callback URL and enter it into your Open edX eduNEXT Application
• Copy the Client ID and Client Secret and save it on your miniOrange OAuth Client plugin Configuration.
• You have successfully completed your Open edX eduNEXT App OAuth Server side configurations.

You have successfully configured Open edX eduNEXT as OAuth Provider for achieving Open edX eduNEXT login into your WordPress Site.

2. Setup WordPress as OAuth Client

• Go to the Configure OAuth tab in the Plugin and search for Custom OAuth in the applications list, and select Custom OAuth 2.0 App .

• Now, configure App Name, Client ID, Client Secret received from Open edX eduNEXT.

• Please refer the below table for configuring the scope & endpoints for Open edX in the plugin.

  Client ID :	from the Open edX eduNEXT application configured
  Client Secret :	from the Open edX eduNEXT application configured
  Scope:	email profile
  Authorize Endpoint:	https://<your-domain>/oauth2/authorize
  Access Token Endpoint:	https://<your-domain>/oauth2/access_token
  Get User Info Endpoint:	https://<your-domain>/api/mobile/v1/my_user_info

• Click on Save Settings to save the configuration.

You have successfully configured WordPress as OAuth Client for achieving Open edX eduNEXT 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.

The following is a sample image for your reference. The attribute names can vary depending on your OAuth provider's configuration.



• 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.
  

  The following is a sample image for your reference. The attribute names can vary depending on your OAuth provider's configuration.

  
  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 Open edX eduNEXT 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 Open edX eduNEXT SSO login button there. You can test the Open edX eduNEXT 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 Open edX eduNEXT SSO login button there. Once you click the login button, you will be able to test the Open edX eduNEXT Single Sign-On (SSO).


In this Guide, you have successfully configured Open edX eduNEXT Single Sign-On (SSO) by configuring Open edX eduNEXT 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 Open edX eduNEXT login credentials within minutes.

Additional Resources

• Open edX eduNEXT as OAuth Provider / OpenID Connect
• Integrating with an OAuth2 Identity Provider
• 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.