You are viewing an earlier version of the admin guide. For the latest version, please visit EmpowerID Admin Guide v7.211.0.0.

Paypal

Owned by Phillip Hanegan
Sept 28, 2020
3 min read

The EmpowerID SSO framework allows you to configure PayPalas an identity provider (IdP) for EmpowerID. EmpowerID integrates with PayPalusing OAuth 2.0.

Prerequisites:

Before configuring PayPal as an OAuth Identity Provider in EmpowerID, you need to meet the following conditions:

  • You must have a PayPal developer account

  • Create an application for EmpowerID in PayPal

Once the IDP Connection has been set up for PayPal, you can create a link similar to the one below to allow users to login to EmpowerID using PayPal.

https://FQDN_OF_YOUR_EMPOWERID_SERVER/WebIdPForms/Login/Portal/PayPal?returnUrl=%2FWebIdPForms%2F

Be sure to replace FQDN_OF_YOUR_EMPOWERID_SERVER with the FQDN of your EmpowerID server.

Steps

To configure PayPal as an Identity Provider for EmpowerID, you need to do the following:

  1. Create an application for EmpowerID in PayPal

  2. Configure the default PayPal OAuth Provider app

  3. Add a Login button to the Login page for PayPal

  4. Test the OAuth provider app

Create an application for EmpowerID in PayPal

To allow users to authenticate to EmpowerID using their PayPal credentials, you must register EmpowerID as an OAuth application in PayPal. See PayPal’s article at https://developer.paypal.com/docs/get-started/ for directions on how to do this. During the app registration process, PayPal will generate an Client ID and Secret for the application. You will use these when you create an OAuth Provider App for PayPal in EmpowerID.

When creating an application for EmpowerID in PayPal, set the following:

Setting

Value

Setting

Value

App Name

Name of the application you are creating. This can be any value.

Return URL

Your application’s redirect URL

https://YOUR_EMPOWERID_SERVER/WebIdPForms/oauth/v2

App Settings

Connect with PayPal

 

Configure the default PayPal OAuth Provider app

  1. On the navbar, expand Single Sign-On > SSO Connections and click OAuth / OpenID Connect.

  2. Select the External OAuth Services tab and then search for PayPal.

  3. Click the Provider link for PayPal.



  4. Click the Edit button for the default PayPal OAuth provider app.



  5. Under General Settings, fill in the following information and then click Save.

Field

Description

Field

Description

Consumer Key

Client ID generated by PayPal

Consumer Secret

App Secret generated by PayPal

Is Identity Provider

Select this option to flag the OAuth provider as an Identity Provider app.

Select existing Account Directory

Select PayPal to place authenticated users in the selected account store.

Callback Url

This is the URI that PayPal redirects users after they have authenticated with PayPal. The URL should look like the following: https://YOUR_EMPOWERID_SERVER/WebIdPForms/oauth/v2, where YOUR_EMPOWERID_SERVER is the FQN of your EmpowerID Web server.

 

Add a Login Button for PayPal

  1. On the navbar, expand Single Sign-On > SSO Connections and click SSO Connections.

  2. Select the IdP Domains tab and then click the IdP Domains link for the IdP Domain where you want the Login tile to appear.



  3. Select the External OAuth Providers tab and then select the PayPal provider.



  4. Click Save.

To give users the ability to log in using their EmpowerID credentials, be sure to select EmpowerID from the SAML Identity Providers tab of the IdP Domain Details page.

Test the OAuth Provider App

  1. Log out of the EmpowerID Web interface and navigate your browser to the domain name you configured for the PayPal IdP connection.

  2. Click the Login Using PayPal button.

  3. Click Okay to allow EmpowerID to retrieve the information it needs to link your PayPal account to your EmpowerID identity (Person object).

    You should be authenticated to EmpowerID.

IN THIS ARTICLE