Setup PayPal Single Sign-on with Drupal OAuth Client
Overview
Drupal miniOrange SSO integration will allow you to configure Single Sign-On ( SSO ) login between your Drupal site and PayPal using OAuth/OpenID protocol. Drupal OAuth 2.0/OpenID connect module gives the ability to enable login using OAuth 2.0/OIDC Single Sign-On to Drupal Site. We provide the Drupal OAuth/OpenID Client module for Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11.
Installation Steps
- Using Composer
- Using Drush
- Manual Installation
Configuration Steps
Setup Drupal as OAuth Client
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select PayPal from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy.
- Enter the application name in the Display Name text field. For example, PayPal.
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 Application in PayPal
- First of all, login into your PayPal Admin Account.
- From the left navigation panel, select My Apps & Credentials.
- Navigate to REST API Apps and click on the Create App button to create a new application.
- In the Create New App panel, Enter the following information:
- Enter the name of application in the App Name text field.
- Select Merchant as the App Type.
- Then, click on Create App button.
Integrating Drupal with PayPal
- PayPal assigns a unique Application ID to your application. Copy the Client ID and Secret ( Client Secret ) key from the SANDBOX API CREDENTIAL section and keep it handy.
- In Drupal’s Configure OAuth tab and paste the copied Client ID and Secret in the Client ID and Client Secret text fields.
- From the PayPal window, scroll to bottom SANDBOX APP SETTINGS, and paste the previously copied Callback/Redirect URL into the Return URL text field. Then Click on + or press Enter. Enable the Log in with PayPal checkbox and click on Save.
- PayPal Endpoints:
| Scope: | openid profile email |
|---|---|
| Authorize EndPoint: | https://www.paypal.com/signin/authorize |
| Access Token Endpoint: | https://api.paypal.com/v1/oauth2/token |
| Get User Info Endpoint: | https://api.paypal.com/v1/identity/oauth2/userinfo |
Test Configuration of Drupal with PayPal
- After successfully saving the configurations, click on the Perform Test Configuration button to test the connection between Drupal and PayPal.
- On a Test Configuration popup, if you don't have an active session in the same browser, you will be asked to sign in to PayPal. After successfully logging into PayPal, you will be provided with a list of attribute that's coming from the PayPal.
- 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 Done button, you will be redirected to the Attribute & Role Mapping tab, in which you can select the Username Attribute from the dropdown list and click on Save Configuration button.
Note: Mapping the Email Attribute is mandatory for your login to work.
- Now log out and go to your Drupal site’s login page. You will automatically find a Login with PayPal link there. 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:
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]
Contact us
[MO_CONTACT_US]
