SSO Login into Drupal using GitLab as OAuth / OpenID Connect Provider
Drupal OAuth/OpenID Connect SSO integration enables SSO between the Drupal site and GitLab. This setup guide helps in configuring Single Sign-On (SSO) between the Drupal site and GitLab using the OAuth/OpenID Connect module. When you incorporate the OAuth/OpenID Connect module with the Drupal site, you can log into the Drupal site seamlessly with GitLab credentials. This module is compatible with Drupal 7, Drupal 8, Drupal 9, and Drupal 10.
Installation Steps:
- Download the module:
composer require 'drupal/miniorange_oauth_client'
- Navigate to Extend menu on your Drupal admin console and search for miniOrange OAuth Client Configuration using the search box.
- Enable the module by checking the checkbox and click on the Install button.
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
- Install the module:
drush en drupal/miniorange_oauth_client
- Clear the cache:
drush cr
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
- Navigate to Extend menu on your Drupal admin console and click on Install new module.
- Install the Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login module either by downloading the zip or from the URL of the package (tar/zip).
- Click on Enable newly added modules.
- Enable this module by checking the checkbox and click on install button.
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
Setup Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab.
- Select Custom OAuth 2.0 Provider from the Select Application dropdown.
- Copy the Callback/Redirect URL and keep it handy.
- Enter the Display Name as the GitLab.
Create OAuth/OpenID SSO Application in GitLab:
- Go to GitLab and log into your Gitlab account.
- Navigate to the Applications tab and click on Add new application button
- Enter the Name for eg. Drupal.
- Paste the Callback/Redirect URL into the Redirect URI text field.
- Select the Scopes as per your requirements.
- Click on the Save application button. You will be displayed with Application ID and Secret.
- Copy the Application ID and Secret.
Integrating Drupal with Gitlab:
- Go to Drupal's Configure OAuth tab and paste the copied Application ID and Secret into the Client ID and Client Secret text fields respectively.
- Copy and paste the following scope and endpoints into the respective text fields at Drupal's Configure
OAuth tab.
Scope openid email profile read_user Authorize Endpoint https://gitlab.com/oauth/authorize Access Token Endpoint https://gitlab.com/oauth/token Get User Info Endpoint https://gitlab.com/api/v4/user Send Client Credentials In Both (In Header and In Body)
Test Connection between Drupal and GitLab:
- Navigate to the Drupal site and click on the Perform Test Configuration button to check the OAuth SSO connection between Drupal and GitLab.
- On a Test Configuration popup, if you don't have an active session in GitLab on the same browser, you will be asked to sign in to your GitLab. After successfully logging into GitLab, you will be provided with a list of attributes that are received from the GitLab.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- Once you click on the Done button, you will be redirected to the Attribute & Role Mapping tab, where you can select the Username Attribute from the dropdown and click the Save Configuration button.
- Scroll to the bottom and click on the Save Configuration button.
Please note: Mapping the Email Attribute is mandatory for Single Sign-On.
Congratulations! You have successfully configured GitLab as an OAuth Provider and Drupal as an OAuth Client.
How to perform the SSO?
- Open a new browser/private window and navigate to the Drupal site login page.
- Click on the Login using GitLab link to initiate the SSO from Drupal.
- If you want to add the SSO link on other pages, 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:
- 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:
Follow the steps mentioned HERE
Follow the steps mentioned HERE
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]
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]
Need Help? We are right here!
