Skip to main content
Eptura Knowledge Center

Enable SSO for Eptura User

Level: Eptura Implementation team / Client IT team

Eptura supports the integration with Ping and this article details how to configure the SSO. This article is written for Administrators and assumes familiarity with Ping and basic identity management concepts.

Contents

Prerequisites


Before configuring SCIM-based provisioning for Eptura, make sure you have an Azure AD to configure IDP connection on Ping to enable the SSO login. Additionally, your Super Admin must be defined in the Azure AD with their First Name, Last Name and Email Address properties completed.

Step 1. Integrate PingFederate with Azure AD


Below are the steps for PingFederate integration.

Step 1.1 Create Azure EntraID App Registration for PingFederate Integration (Client Team)

  1. Sign in to Microsoft Azure https://azure.microsoft.com/en-us/
Primary Domain Name
  1. From the menu, navigate to Microsoft EntraID > Overview.
  2. Copy the Primary domain name and paste this into a text editor as we will use this later in the steps.

clipboard_e2988236398461c23dd1f17dd7586265e.png

App Registrations
  1. From the menu, navigate to Manage > App Registrations.
  2. Click the New Registration button and the Register an application screen displays.

clipboard_eddac31c1c91e15bd35cc971326915e35.png

  1. In the Name field, enter the name for this app that will integrate this Azure instance with Eptura company’s Ping instance. For example PingFederation Integration.
  2. For the "Who can use this application or access this API? option, select Accounts in this organizational directory only - Single tenant.
  3. From the Redirect URI (optional) drop-down, select Web and note that the URI value will be set later on.
  4. Click the Register button and the application is registered.
Application (client) ID
  1. From the App registrations > Overview.
  2. Copy the Application (client) ID and paste this into a text editor as we will use this later in the steps.

clipboard_e1fb4deb7464325b647ebf7c1a99913a6.png

Endpoints

clipboard_e236e0c7d5928d79e5f8a8f0443afc4e4.png

  1. Click the Endpoints tab and the Endpoints form displays.
  2. Browse the list to find OpenId Connect metadata document.
  3. Copy the value and don't include the characters after /v2.0/ and paste this into a text editor as we will use this later in the steps.

clipboard_ec4f36303de1cdb70863c0d0b01462e8d.png

  1. Click the X icon to close the Endpoints form.  
Certificates & secrets
  1. From the menu, select Manage > Certifications & secrets.

clipboard_eb058614ba145e9f36515a0e285c77c87.png

  1. Click New client secret and the Add a client secret form displays.

clipboard_efebec42cc95077ef87bb52a7e8e14158.png

  1. In the Description field, enter a short description. For example pingsecret1.
  2. From the Expires drop-down, set the expiration to 730 days (24 months).
  3. Click the Add button and the application credentials are saved.

clipboard_e143273621c63577c8390ea2f6e8961af.png

A secret key will be generated, make sure you copy the secret key's value. We recommended that you keep a copy of the secret key in a secured location.

Rememberer to note the expiry date as this secret needs to be refreshed 30 days before the expiry and share this with Eptura.

Provide the following information to the Eptura Implementation team:

  • Primary domain name
  • Application (client) ID
  • OpenId Connect metadata document
  • Client secret value
Optional - Test the sync with the Eptura Platform Tenant 

If you want to test with a few users first, before before syncing all AD users with Eptura.

  1. From the main menu, click Enterprise applications.
  2. Click the application name. For example PingFederateIntegration.
  3. From the menu, click Manage > Properties.
  4. For the Assignment required, click Yes.

When this is set to No, then all the AD Users will sync with Eptura.

clipboard_ee038d87d5841700b8c2d1692cd9036c6.png

Step 1.2 Get Redirect URIs from PingFederate (Implementation Team)

  1. Sign in to PingFederate https://ssoadmin.epturacloud.com/render/pingfederate/app
  2. Click the Applications tab.

clipboard_eeaa3c743445f3bf49a89d2ce2094890e.png

When you are onboarded there will be 3 clients automatically created:

  1. Client ID and Client Name has the suffix _epturaPFHost (This is your Ping Application.)
  2. Client ID and Client Name has the suffix _tenantAppService
  3. Client ID and Client Name has the suffix _scimUsers

clipboard_ebb5249c1eabbb8cca8396229dfc3616c.png

Step 1.3 Create an IDP connection in PingFederate (Implementation Team)

  1. Click the Authentication tab.
  2. Click the IdP Connections tile and the IdP Connections screen displays.

clipboard_e5b3a05ac43801dd64cb4b814b0303ebf.png

  1. Scroll down the page and click the Create Connection button. The IdP Connections screen displays.

clipboard_e2b921189de8cf6fa7a248b8e1681292f.png

  1. Check the Browser SSO Profiles check box.
  2. From the Protocol drop-down, select OpenID Connect.
  3. Click the Next button.

clipboard_ef87d8c78b386efac2c9ae505681d37b8.png

  1. Check the OAuth Attribute Mapping check box.
  2. Click the Next button and General Info tab displays.

clipboard_e095d93093d797cba3dfdd021d40e1063.png

The General Info tab is where you will use the information the customer provided (above).

  1. In the Issuer field, enter the truncated value that you saved of the OpenId Connect metadata document value from Endpoints (above).
  2. Click the Load Metadata button and will see the message, “Metadata successfully loaded. The issuer was updated to match the `iss` value from the discovery endpoint.”
  3. In the Connection Name field, enter the Primary Domain Name from Primary Domain Name (above).
  4. In the Client ID field, enter Ping Application (client) ID from Application (client) ID (above).
  5. In the Client Secret field, enter the Client Secret from Certificates & Secrets (above). 
  1. Click the Next button and the Browser SSO tab displays.
  2. Click the Configure Browser SSO button.

clipboard_ec2ca53cfbb99e18ba298c141e5bf676d.png

  1. Click the Configure User-Session Creation button and User-Session Creation screen displays.

clipboard_eca8a38c675c1f2ba77ec58bbebeeb69f.png

  1. Click the Identity Mapping tab.

clipboard_ea0b838b3a2980e084586c138d025ded6.png

  1. Select the No Mapping option, because the connection will be used within an authentication policy. 
  2. Click the Next button.

clipboard_ed3d40930d0f321135b871feb9d328c56.png

  1. Scroll to the end of the screen.

clipboard_eeb19bbcedbbd4b9403a7036254494400.png

  1. Add the following attributes:
    • family_name
    • given_name
  2. Click the Done button and the Browser SSO screen displays.

clipboard_e9220789784e0891e062cf07cd2f728ec.png

  1. Click the Next button to display the OAuth Attribute Mapping screen.

clipboard_e2946bb9738d09c7b827652c04b9e59cd.png

  1. Click the Configure OAuth Attribute Mapping button.

clipboard_edde6419afc437f466e38ba188137666f.png

  1. For the USER_KEY's Source drop-down, select Provider Claims and from the Value drop-down, select preferred_username.
  2. For the USER_NAME's Source drop-down, select, Provider Claims and from the Value drop-down, select preferred_username.
  3. Click the Next button to display the Inssuance Criteria tab.
  4. Click the Next button to display the Summary tab.
  5. Click the Done button to display the Browser SSO screen.

clipboard_ef3b2f050b3a646d8006abca817c5daf2.png

  1. Click the Next button to display the Protocol Settings tab.
  2. Click the Next button to display the Summary tab.
  3. Click the Done button to display the IdP Connection screen.

clipboard_eb8c73b6b8f8263f4f1ddfc4b9c4accdc.png

  1. Click the Next button to display the Activation & Summary tab.
Redirect URL

This displays the Redirect URI and this starts with https:// and ends with .openid 

clipboard_e642890ce503c2240f078619489df9bc8.png

  1. Copy the URI and paste it into a Text Editor.
  2. Replace localhost with the Ping host based on your Eptura tenant’s environment.
  1. Scroll to the end of the screen.
  2. Click the Save button.

The connection is created and activated and you will see it in the list of IdP Connections.

Provide the IdP Connection Redirect URI to the customer.

Step 1.4 Optional - Cluster Management

This needs to be done only if the Cluster Management warning is visible on the PingFederate console.

clipboard_e1d498f40c4ccff47c19f0fb767f81793.png

  1. From the note, click the Cluster Management link.

clipboard_ee09873242d02c0a58f60c369df4972e0.png

  1. Click the Replicate button and this displays the message " Cluster node notified of new configuration".

Step 1.5 Set Ping redirect URI in Azure Ping application (Client Team)

  1. Sign in to Microsoft Azure https://portal.azure.com/
  2. Navigate to Microsoft EntraID.
  3. From the menu, select Manage > App Registrations.
  4. Click the All applications tab.
  5. Select the PingFederate application name you created.

clipboard_e5b9c5fba50091baff089bed8ab5683e3.png

  1. From the menu, select Authentication.

clipboard_e8e0d921253ee995322fb49acf333f3e0.png

  1. Click the + Add a platform button and the Configure platforms form displays.

clipboard_ec0d54aaa624ebc0d39de62f02a96c606.png

  1. Click the Web tile and the Configure Web form displays.

clipboard_e11d9f7cda0c2281192761079a3a157ec.png

  1. In the Redirect URIs field, paste in the IdP Connection Redirect URI. From Redirect URI (above).
  2. Click the Configure button.

clipboard_e41c0b2f66f5fa5072cc05345c0ac2aa7.png

Step 1.6 Redirect incoming requests to IdP in PingFederate (Implementation Team)

  1. Sign in to PingFederate https://ssoadmin.epturacloud.com/render/pingfederate/app
  2. Click the Authentication tab.
  3. From the menu, click Policies > Selectors.

clipboard_e596f4df64107f10b63d6a0077d33bc48.png

  1. Click the HttpRequestDomainSelector instance name.
  2. Click the Selector Result Values tab.
  3. Scroll to the end of the screen
  4. In the Results Value field, enter the primary domain.
  5. Click the Add button.
  6. Click the Save button.

Remember if you see the Cluster Management message then you need to complete the replication, see Step 1.4 Optional - Cluster Management.

Next, you will find the domain in a policy and define what will happen if a login attempt to that domain fails or succeeds.

  1. Click the Authentication tab.
  2. From the menu, click Policies.

clipboard_e3a8ed172e31d29408a92727c80687009.png

  1. Scroll down to the policy.
  2. Click DomainSelectorPolicy.
  3. Scroll down and under the HttpRequestDomainSelector there will be a list of the existing domains.

clipboard_e540309f4d2e9fdc48024dd35a4ed9591.png

  1. Locate your domain and click the drop-down.

clipboard_e95508de6252a566a8bed0515a9e14224.png

  1. From the drop-down, select the IdP Connection.
  2. Either browse the list or search for your domain name.
  3. Select the domain name.

Next, complete the Fail and Success for your connection.

clipboard_eee3c0bd1a0049ba36e9cf364da5b3cc9.png

  1. For Fail, click Done and this is set to Done. 
  2. For Success, click Done and this is set to Done. 

clipboard_ee6d01406f7294a34fba7818df2736125.png

  1. Click the Save button.

Remember if you see the Cluster Management message then you need to complete the replication, see Step 1.4 Optional - Cluster Management.

Step 1.7 Add access token mapping in PingFederate (Implementation Team)

  1. Click Applications tab.
  2. From the menu, click OAuth > Access Token Mappings.
  3. Scroll down the screen.

clipboard_e52e5e853466eddb2d6ff6267ddb9cb3a.png

  1. From the Context drop-down, select your IDP connection.
  2. From the Access Token Manager drop-down, select Default Access Token Management.
  3. Click the Add Mapping button.

clipboard_eb765c46de76940d9a058c06d13deb8d9.png

  1. Click the Add Attribute Source button.

clipboard_ebcb9fce9b48b5fbb03a00023459b4724.png

  1. In the Attribute Source Id field, enter userCustomClaimSource.
  2. In the Attribute Source Description field, enter userCustomClaimSource.
  3. From the Active Data Store drop-down, select shared-auth-service-ds.
  4. Click the Next button and the Configure Data Source Filters tab displays.

clipboard_e5f79aaaa26cf52404ea3ae20c07dd6ba.png

  1. Scroll down to the Body.
  2. In the Body field, paste the JSON code.
{ "data": { "cid": "${context.ClientId}", "login": 
"${idp.preferred_username}", 
"firstName": "${idp.given_name}", 
"lastName": "${idp.family_name}" } }
  1. Click the Next button.
  2. Click the Save button.

You will see messages that some mappings are required.

clipboard_e20600ba38731cf7ac42c3a45948d5b90.png

  1. Scroll down to the mappings.
  2. Complete the following mappings:
Contract Source Value
firstname Idp Connection given_name
lastname Idp Connection family_name
platform_domain Other (userCustomClaimSource) platform_domain
platform_env Other (userCustomClaimSource) platform_env
platform_namespace Other (userCustomClaimSource) platform_namespace
products Other (userCustomClaimSource) products
session_id Other (userCustomClaimSource) session_id
sub Idp Connection preferred_name
super_user Other (userCustomClaimSource) super_user
tenant_id Other (userCustomClaimSource) tenant_id
user_id Other (userCustomClaimSource) user_id
  1. Click the Next button the Issuance Criteria tab displays.
  2. Click the Next button the Summary tab displays.
  3. Click the Save button. 

Remember if you see the Cluster Management message then you need to complete the replication, see Step 1.4 Optional - Cluster Management.

Step 2. Sign in Eptura using a SSO user (Client Team)


Learn how to sign in to Eptura - Authentication Methods using a SSO user or using Basic Auth where your user was created manually. 

Step 3. Integrate SCIM with User Directory (Client Team)


Your IdP gets connected to the SCIM service, using the SCIM URL and SCIM token. When connected, the SCIM service will automatically import all user accounts that are in the your IdP. The attributes of the users in you IdP need to be mapped to SCIM. After the initial synchronization, additional synchronizations happen on a schedule of every 40 minutes. See the article, Configure SCIM provisioning for Microsoft Entra ID

Step 4. User Access to Eptura Applications


Users created in Microsoft Azure are syned to Eptura as a person, you can change the access the user has to the Eptura Applications, see Add, Edit, or Delete a Group.