--- title: Configure PingOne for Coveo SSO slug: '1706' canonical_url: https://docs.coveo.com/en/1706/ collection: manage-an-organization source_format: adoc --- # Configure PingOne for Coveo SSO [PingOne](https://www.pingidentity.com/en/lp/single-sign-on-sso.html) is a service providing single sign-on (SSO) for web and mobile applications. As a Coveo administrator, you can [implement Security Assertion Markup Language (SAML) 2.0 SSO](https://docs.coveo.com/en/1979/) when your company uses PingOne. Users can then log in to Coveo without having to provide their authentication credentials since their identity has previously been validated when logging in to their PingOne session. To allow users to log in via SAML SSO, Coveo must be able to trust and rely on PingOne to authenticate users wanting to log in. To establish this trust relationship, you must configure PingOne and Coveo so that both parties can exchange authentication information. This page explains how to proceed. To configure SSO in more than one Coveo organization, for example in a production organization and a [sandbox organization](https://docs.coveo.com/en/2959/), configure one of these organizations, and then follow [the instructions](#configure-sso-in-another-organization) at the end of this page. > **Note** > > If you're not the PingOne administrator at your company, contact them so they configure PingOne using the following steps. ## Configure PingOne Both PingOne and Coveo must be configured to work together and provide a SAML SSO service to your Coveo users. First configure PingOne so that it can provide Coveo with user authentication data. . Log in to your [PingOne Administrator](https://admin.pingone.com/) account. . Select the **Applications** tab. . Click the **Add Application** dropdown menu, and then **New SAML Application**. . Under **1. Application Details**: .. In the **Application Name** box, enter an application name to display in your **Applications** page. .. In the **Application Description** box, enter a short application description. .. In the **Category** dropdown menu, select a category to label the application. .. Click **Continue to Next Step**. . Under **2. Application Configuration**: > **Note** > > You might need to scroll up on this page to see all options. .. Next to **Upload Metadata**, click **Or use URL**, and then enter one of the following addresses. Alternatively, you can download the XML file from the URL, and then click **Select File** to upload it. *** For a regular (non-HIPAA) organization: `+https://platform.cloud.coveo.com/saml/metadata+`. *** For a HIPAA organization: `+https://platformhipaa.cloud.coveo.com/saml/metadata+`. *** For an organization with [data residency outside the US](https://docs.coveo.com/en/2976/): `+https://platform-.cloud.coveo.com/saml/metadata+`. .. The **Assertion Consumer Service (ACS)** and **Entity ID** boxes are automatically filled, and a **Primary Verification Certificate** is loaded. Click **Continue to Next Step**. . Under **3. SSO Attribute Mapping**: .. Click **Add new attribute**, and then fill the boxes using the following table values. [cols=",,^"] |=== | Application attribute | Identity bridge attribute or literal value | Required | `user.email` | Email | [check] |=== .. To [import your PingOne groups in Coveo](https://docs.coveo.com/en/1980#import-members), click **Add new attribute** again, and then fill the boxes using the following table values. > **Note** > > Importing your PingOne groups into Coveo allows you to create several Coveo organization members at once. If you don't import your PingOne groups, you must [add your PingOne users to your Coveo organization one by one](https://docs.coveo.com/en/1821/). [cols=",,^"] |=== | Application attribute | Identity bridge attribute or literal value | Required | `user.groups` | memberOf | [check] |=== .. Optionally, to add additional attributes, click **Add new attribute** again, and then fill the boxes. **Example** You could choose to add the following attributes: |=== | Application attribute | Identity bridge attribute or literal value | `user.firstName` | First Name | `user.lastName` | Last Name |=== .. Click **Save & Publish**. . Under **4. Review Setup**, review your configuration. You'll use the information displayed on this page to configure Coveo. . Click **Finish**. ## Prepare to configure Coveo Once you've configured PingOne so that it passes the right information about user authentication to Coveo, you must configure Coveo to enable federation between Coveo and PingOne. To do so, retrieve data to later import into Coveo: . In the **My Applications** PingOne page, click the application you just created to display your application configuration. . Next to **Signing Certificate**, click **Download**. . Once you have downloaded the file, open it with a text editor such as Notepad{plus}{plus}. This is the public certificate you'll enter in the Coveo configuration panel. . Next to **SAML Metadata**, click **Download**. . Once you have downloaded the file, open it with a text editor such as Notepad{plus}{plus}. ** The `entityID` displayed at the top of the document must be entered in the Coveo configuration panel. ** The `SingleSignOnService` POST binding address displayed towards the bottom of the file must be entered in the Coveo configuration panel, in the **Single sign-on URL** box. ## Configure Coveo Once you've configured your identity provider to provide Coveo with user authentication data, you must configure Coveo to trust your identity provider and accept to rely on it for user authentication. . With the [data required to fill the Coveo configuration form](#prepare-to-configure-coveo) in hand, access the **Settings** page: .. [Log in to Coveo](https://platform.cloud.coveo.com/login) ([platform-ca](https://platform-ca.cloud.coveo.com/login) | [platform-eu](https://platform-eu.cloud.coveo.com/login) | [platform-au](https://platform-au.cloud.coveo.com/login)) as a [member](https://docs.coveo.com/en/2869/) of a [group](https://docs.coveo.com/en/2867/) with the [required privileges](https://docs.coveo.com/en/1562#required-privileges) to manage settings in the target [Coveo organization](https://docs.coveo.com/en/185/). .. On the **Settings** page, select the **Organization** tab, and then select the **Single Sign-On** subtab. . In the **Single Sign-On** subtab, in the **Identity provider name** box, enter the identity provider name as you want it to appear on your Coveo organization [login page](https://docs.coveo.com/en/1697/). . In the **Single sign-on URL** box, enter the URL where Coveo must send an authentication request. The SSO URL may also be called _Assertion Consumer Service_ (ACS). . In the **Identity provider issuer URI** box, enter the identity provider issuer unique URI. The identity provider issuer URI may also be called _entity ID_ or _federation service identifier_. . Using one of the following methods, provide Coveo with the identity provider's Base64 public certificate to validate the identity provider signature: * Paste the certificate in the **Enter your public certificate** box. * If you saved the certificate on your computer, click **Choose File** to browse your files and upload the certificate. . Click **Add**. > **Note** > > If you encounter a **SAML Authentication Error** while logging in to the hosted search page, it's typically because the SSO configuration has not been updated prior to the scheduled rotation of the certificate. To resolve this issue, the Coveo administrator can update the certificate on the [**Settings**](https://docs.coveo.com/en/1562/) page of the [Coveo Administration Console](https://docs.coveo.com/en/183/). > > To avoid this error, a Coveo administrator can add a [notification](https://docs.coveo.com/en/1583#add-or-edit-an-organization-notification) as a reminder to update the certificate prior to the rotation date. ## Encrypt PingOne assertions [Assertion encryption](https://docs.coveo.com/en/1979#assertion-encryption) is optional. To encrypt PingOne assertions, retrieve the Coveo public certificate and import it into your PingOne configuration: . On the [**Settings**](https://platform.cloud.coveo.com/admin/#/orgid/settings/license) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/settings/license) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/settings/license) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/settings/license)) page, on the **Single Sign-On** tab, under **Advanced Option**, download the Coveo certificate. . Access your PingOne application configuration: .. Log in to your [PingOne Administrator](https://admin.pingone.com/) account. .. Select the **Applications** tab. .. On the **My Application** page, click your Coveo application. . Under the application configuration, click **Edit**. . Under **1. Application Details**, click **Continue to Next Step**. . Under **2. Application Configuration**: .. Check the **Encrypt Assertion** box. .. Next to **Encryption Certificate**, click **Select file**, and then select the Coveo public certificate you downloaded. .. Next to **Signing**, select **Sign Response**. .. Click **Continue to Next Step**. . Under **3. SSO Attribute Mapping**, click **Save & Publish**. ## Test your configuration . [Add your email address as an organization member](https://docs.coveo.com/en/1821/). In the **Add a Member** dialog, under **Provider**, ensure to select **Single sign-on**. . [Log out of the Coveo Administration Console](https://docs.coveo.com/en/1841#user-menu), and then [log back in using the SSO option and your identity provider account](https://docs.coveo.com/en/1697#logging-in-with-sso). By doing so, you ensure Coveo and your identity provider work together properly. > **Important** > > We strongly recommend that you don't delete the account with which you first logged in to the Administration Console and implemented SAML SSO. > This original account is a "backdoor" that prevents you from being locked out if the SAML SSO doesn't work as expected. > At any time, you can log in with your original, non-SSO identity provider, and then edit the Coveo configuration. > For details on how accounts belonging to the same individual are separated, see [Multiple Accounts](https://docs.coveo.com/en/1697#multiple-accounts). > > Alternatively, if you must delete your original account, you can also create another non-SSO administrator account with the [required privileges](https://docs.coveo.com/en/1562#required-privileges) beforehand. > [Logging in via email](https://docs.coveo.com/en/1697#logging-in-with-email) is also an alternative. ## Invite SSO users Once you've verified that your SSO configuration works, [invite SSO users to join your Coveo organization](https://docs.coveo.com/en/1821/). > **Important** > > Once you set up an SSO for your organization, users accessing a hosted search page of this organization are automatically redirected to the [SSO login page](https://docs.coveo.com/en/1697/). Therefore, after configuring your SSO, promptly invite your users as SSO users of this organization. Otherwise, users will enter their identity provider credentials, but access to the hosted search page won't be allowed since there will be no Coveo SSO user corresponding to the provided credentials. ## Configure SSO in another organization If you have multiple Coveo organizations, such as a production organization and a [sandbox organization](https://docs.coveo.com/en/2959/), you must use the same SSO settings for all organizations. Users will then use the same SSO credentials to log in, regardless of the organization they are accessing. Follow these steps to configure SSO in additional organizations: . Ensure that the user identity you'll use to configure SSO: -- ** Is a [member](https://docs.coveo.com/en/2869/) of all [organizations](https://docs.coveo.com/en/185/) where the SSO configuration will be used, including the original organization where SSO is already configured. If it's not already a member, this user identity must be [invited](https://docs.coveo.com/en/1821#add-members) to the organizations and [accept the invitations](https://docs.coveo.com/en/1697#after-login). ** Has the [privilege](https://docs.coveo.com/en/228/) to edit SSO settings (**Edit** on the [**Single sign-on identity provider** domain](https://docs.coveo.com/en/1707#single-sign-on-identity-provider-domain)) in each of these organizations. -- . Using this identity, log in to the organization where you want to configure SSO. . In the [**Single Sign-On**](https://platform.cloud.coveo.com/admin/#/orgid/settings/organization/sso) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/settings/organization/sso) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/settings/organization/sso) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/settings/organization/sso)) tab of the **Settings** page, delete any existing SSO configuration. Save your change. This will also permanently delete the associated SSO members from your Coveo organization. . Copy the SSO settings from the first organization to the other. The SSO settings provided to Coveo must be identical across all organizations, including the identity provider name. > **Tip** > > Open the organization where SSO was originally configured in a private browser window. > This will let you copy and paste from one organization to the other without logging in and out to switch between them. . Follow the remainder of the deployment process above, starting at the assertion encryption step, for each organization where you copied the SSO settings.