GitHub Single Sign-On (SSO) Integration with Drupal OAuth / OpenID Connect Client

Overview

Drupal OAuth Client module enables Single Sign-On i.e. SSO for a Drupal site with any Identity Provider using OAuth or OpenID connect protocol. Here we will go through the steps to configure the module with the GitHub. Once this configuration is done, users will be able to log in to the Drupal site using their GitHub credentials.
The integration of Drupal with GitHub simplifies and secures the login process, completely removing the need to store, remember, and reset multiple passwords.

Playground Schedule a Meeting

Installation Steps

Configuration Steps

Setup Drupal as OAuth Client:

• After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select GitHub from the Select Application dropdown list.

• Copy the Callback/Redirect URL and keep it handy. It will require to setup GitHub as OAuth provider.


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.



• Enter the application name in the Display Name text field. For example, GitHub.

Create SSO Application in GitHub:

• Go to GitHub and Login/Sign up to your GitHub account.
• You will be presented with the following screen. Click on Register a new application.

• After successfully registering your app on GitHub, you will be given Client ID and Client Secret, copy them. You’ll need them in the next step.

Integrating Drupal with GitHub:

• Go to miniOrange OAuth Client module.
• In Drupal’s Configure OAuth tab paste the copied Client ID and Client Secret in the Client ID and Client Secret text fields.

• Confirm the Scope and Endpoints from the table below and click on the Save Configuration button.

Scope	user repo
Authorize EndPoint	https://github.com/login/oauth/authorize
Access Token Endpoint	https://github.com/login/oauth/access_token
Get User Info Endpoint	https://api.github.com/user

Test Connection between Drupal and GitHub:

• After successfully saving the configurations, please click on the Test Configuration button to test the connection between Drupal and GitHub.

• On a Test Configuration popup, if you don't have any active sessions on the same browser, you will be requested to login into the GitHub. After successfully logging into the GitHub, you will be provided a list of attributes received from the GitHub.
• Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.


Note: Mapping the Email Attribute is mandatory for your login to Freja eID.

• On the Attribute & Role Mapping tab, please select the Username Attribute from the dropdown list and click on the Save Configuration button.

• Now log out and go to your Drupal site’s login page. You will automatically find a Login with GitHub link there. If you want to add the SSO link to other pages as well, please follow the steps given in the image below:

Congratulations! You have successfully configured GitHub as OAuth/OpenID Provider and Drupal as an OAuth Client.

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:

• Attribute Mapping - map user's attributes received from OAuth Provider with Drupal fields
• Role mapping - assign a Drupal Role to users on the basis of their role/attribute on the OAuth provider
• Enable single logout - Logout user from the OAuth Provider (i.e. AWS Cognito, Azure AD B2C, Keycloak, Okta) when they logs out form Drupal
• Restrict anonymous access to the complete site or a particular section of the site
• Add Multiple OAuth Provides
• Explore All the features offered by the OAuth Client

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]

24/7 Support

The Drupal developers at miniOrange offer quick and active support for your queries. We can assist you from choosing the best solution for your use case.

 Contact us

Case Studies

miniOrange has successfully catered to the use cases of 400+ trusted customers with its highly flexible/customizable Drupal solutions.

 Read more

Other Solutions

Feel free to explore other Drupal solutions that we offer the popular solutions used by our trusted customers include 2FA, User Provisioning, Website Security.

 Know More