SSO Login into Drupal using Facebook as OAuth / OpenID Connect Provider
Drupal OAuth/OpenID Connect SSO integration enables SSO between the Drupal site and Facebook. This setup guide helps in configuring Single Sign-On (SSO) between the Drupal site and Facebook 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 Facebook 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
Set up Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab.
- Select Facebook from the Select Application drop-down.
- Copy the Callback/Redirect URL and keep it handy.
- Enter a Display Name of your choice, such as Facebook.
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 OAuth SSO Application in Facebook (Meta):
- Sign in or sign up at the Facebook Developer console and go to the My Apps.
- Navigate to the All Apps section and click on the Create App button to build a new OAuth application.
- Select the option as your need to create an App and click on the Next button.
- Select an app type and click the Next button. (After your app is built, the app type cannot be changed.)
- In the Details section, enter the Application name in the Add an app name text field and the App contact email (the default is your Facebook account email), then click the Create app button.
- After clicking the Create app button, a dialogue box will display. For your security, you must re-enter your password and click on Submit.
- In the Add product to your app section, click on the Set up button of the Facebook Login card.
- Navigate to the Products -> Facebook Login -> Settings from the left navigation panel.
- Go to the Client OAuth Settings and paste the Callback/Redirect URL into the Valid OAuth Redirect URIs text field.
Note: If your provider only supports HTTPS Callback/Redirect URL and you have an HTTP site, just save your base site URL at the Sign In Settings tab with HTTPS in the OAuth Client module.
- Click on Save changes button.
- Navigate to Settings -> Basic from the left navigation panel.
Integrating Drupal with Facebook:
- Navigate to Facebook's developer console.
- Copy the App ID.
- Click on the Show button of the App secret and copy the App secret.
- Go to Drupal's Configure OAuth tab and paste the copied App ID and App Secret into the Client ID and Client Secret text fields respectively.
- Check the Scope and Endpoints, and then click on the Save Configuration button.
You can also refer to the Facebook Endpoints and scope from the table below:
| Scope | public_profile email |
| Authorize Endpoint | https://www.facebook.com/dialog/oauth |
| Access Token Endpoint | https://graph.facebook.com/v2.8/oauth/access_token |
| Get User Info Endpoint | https://graph.facebook.com/me/?fields=id,name,email,age_range,first_name,gender,last_name,link |
Test connection between Drupal and Facebook:
- Click the Perform Test Configuration button to check the OAuth SSO connection between Drupal and Facebook (Meta).
- On a Test Configuration popup, if you don't have any active session in Facebook on the same browser, you will be asked to log into the Facebook account. Once you are successfully logged into the Facebook account, you will be provided with a list of the attributes that are received from Facebook.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- After clicking on the Done button, you will be redirected to the Attribute & Role Mapping tab. Here, you can also choose the Username Attribute from the dropdown and click on the Save Configuration button.
Please note: Mapping the Email Attribute is mandatory for Single Sign-On.
Congratulations! You have successfully configured Facebook (Meta) as OAuth/OpenID Provider and Drupal as an OAuth Client.
How to perform the SSO?
- Now, open a new browser/private window and go to your Drupal site login page.
- Click on the Login using the Facebook link to initiate the SSO from Drupal.
- 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:
- 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!
