Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Single Sign-On (SSO) is an account security feature that authenticates users and grants access to applications. Only Referrers can use the SSO feature to loginlog in.

Single Sign-On utilizes Security Assertion Markup Language (SAML 2.0) or OpenID Connect (1.0) protocols to defer user authentication to your chosen IdP and provide identity data for platform access control.

...

Once you have chosen your preferred IdP and are ready to enable SSO for the Payrix Platform, follow the instructions below for the protocol you’re using:

OneLogin Setup

How to Implement

...

SAML

For this example, we will be using OneLogin. Follow your IdP instructions for connection.

...

Expand
titleInstructions - OneLogin OpenID

Step 1: Access the Single Sign-On menu

  1. In the OneLogin app, access the OpenID application and click Configurations.

  2. In the Portal, navigate to Settings > Business Settings (Settings category) > Hosts > Single Sign-On and click the “edit” button.

  3. Select OpenID from the “Single Sign-On Protocol” drop-down and copy the Redirect URLs; paste them in the Redirect URLs section of the OneLogin Configurations tab app.

Step 2: Enable OneLogin Single Sign-On

  1. In the OneLogin app, navigate to the SSO tab.

  2. Copy the following fields from OneLogin and paste them in into the Portal Single Sign-On menu fields:

OneLogin App (Copy)

Payrix Portal (Paste)

Notes

Issuer URL

Entity ID

Client ID

Client ID

Client Secret

Client Secret

Click “show” to reveal the secret to be copied.

Step 3: Apply Single Sign-On Configuration

  1. In the Portal, click the checkmark (where the edit button was) to confirm and save the changes.

  2. Navigate to the Profile page and click the Update Single Sign-On button.

Done.

Your new Single Sign-On setup is complete.

...

Google

How to Implement

...

SAML

For this example, we will be using Google. Follow your IdP instructions for connection.

Expand
titleInstructions - Google SAML

Step 1: Setup in Google Admin

  1. From the home page of the Google Admin console, navigate to Apps->SAML Apps and click: Add App > Add custom SAML app.

  2. Add a name into the App Details page.

  3. Download the IdP metadata or Copy the SSO URL, Entity ID, and download the Certificate; then, click Continue.

Step 2: Enable Access to Portal

  1. In the Portal, go to the Single Sign-On menu.

  2. Copy these fields from the Single Sign-On menu and paste them into the Service Provider Details window of the Google Admin console. Then click Finish

Payrix Portal →

Google Admin console

ACS URL

ACS URL

Entity ID

Entity ID

Start URL

Start URL

Step

2

3: Turn on your SAML App

  1. From the Google Admin console, go to Apps and select your new SAML app.

  2. Click User accessAccess, then locate the On/Off for Everyone toggle.

    1. On for everyone - Enables SSO with SAML for everyone in your Google organization.

    2.  Off for everyone - Disables SSO with SAML for everyone in your Google organization.

  3. When finished, click Save.

Step 3: Enable SSO for a Host

  1. In the Portal, navigate to Settings > Business Settings (Settings category) > Hosts

  2. Locate the desired Host name Hostname and click on their listing. You will be taken to their Profile page.

  3. In the Profile page, click Features then , locate Single Sign-On within the menu, and toggle it to On.