Single Sign On (SSO)

SSO: Azure (SAML)

Overview

Use your enterprise Azure authentication on the CCAI Platform platform. When enabled, you can use enterprise-wide Azure credentials to log in to the CCAI Platform Portal and Agent Adapter. The Azure Sign On feature uses SAML authentication protocol.

Prerequisites

To enable Azure Sign In using SAML protocol you must have:

  • Azure account for Azure to serve as an Identity Provider

  • Azure developer account

  • Admin user login

  • Contact Support to enable.

Configuration

Step 1: Azure developer setup

  1. Log in to your existing Azure account.

  2. Navigate to the Azure Portal and click Enterprise applications:

  3. From the Enterprise applications page, click New application:

  4. In the search box type saml.

  5. Click Azure AD SAML Toolkit.

  6. If desired, change the application Name, then click Create.

  7. Click Set up single sign on.

  8. Click the SAML option.

  9. Beside Basic SAML Configuration, click Edit.

  10. For Identifier (Entity ID), enter https://<environmentname>.domain.co/saml/v1/metadata

  11. For Reply URL (Assertion Consumer Service URL), enter https://<environmentname>.domain.co/saml/v1/consume

  12. For Sign on URL, enter https://<environmentname>.domain.co/

  13. Click Save at the top of the screen.

  14. Beside User Attributes & Claims, click Edit.

  15. Click Unique User Identifier (Name ID).

  16. Change Source attribute to user mail, then click Save.

  17. Verify that the Unique User Identifier has been changed to user mail.

  18. Copy and save the Login URL and Azure AD Identifier to use later in the CCAI Platform Portal.

  19. Click the download link for Certificate (Base64).

  20. Open the file in a text editor for later use.

Enable external auth/ SSO in the CCAI Platform Console

  1. Navigate to the CCAI Platform Console.

  2. Choose your project from the drop-down menu at the top of the page. You can either choose an existing instance or create a new one.

  3. Under Login configuration for your instance, select SAML.

  4. Under Entity ID, paste the Azure AD Identifier you copied from the Azure portal.

  5. Under SSO URL, paste the Login URL you copied from the Azure portal.

  6. Under Email Field Mapping enter NameID.

  7. In the Certificate text box, copy the contents of the downloaded Certificate (Base64) file from your text editor. Make sure "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----" are included.

  8. Click Create (new instance) or Save (pre-existing instance).

Step 3: Verify Azure authentication

  1. Navigate to the Agent Adapter in your CRM application. The login page appears.

  2. Click Login with Company SSO. A pop-up window is displayed, prompting you to log in with your Azure credentials

  3. After successfully logging in to the Agent Adapter in the CRM, open a new private (incognito) tab in your web browser and navigate to the CCAI Platform Portal.

  4. Click Login with Company SSO and enter your Azure credentials:

  5. Repeat the login verification steps multiple times to ensure the SAML SSO authentication works without any errors. On successful verification, you can log out of the CCAI Platform Portal, retaining the Login Policy updates.

SSO: Idaptive (SAML)

Overview

The Idaptive Single Sign On feature in CCAI Platform allows you to use your enterprise Idaptive authentication to log in to the CCAI Platform Portal and Agent Adapters. The Idaptive Sign In feature uses SAML authentication protocol.

Prerequisites

To enable Idaptive log in using SAML protocol, you must have:

  • Idaptive account for Idaptive to serve as an Identity Provider

  • Idaptive developer account

  • Admin user login

Idaptive developer setup

  1. Log in to the Idaptive admin portal.

  2. From the left menu, click Web Apps:

  3. Click the Add Web Apps button:

  4. Click the Custom tab:

  5. Locate the SAML web app and click Add:

  6. On the confirmation dialog, click Yes:

  7. On the SAML Web App Settings page, enter a Name and click Save:

  8. On the SAML Web App page, click the Trust tab:

  9. Navigate to the Identity Provider Configuration (IPC) section and select Manual Configuration:

  10. Copy and save the Entity ID for later use in the CCAI Platform Portal.

  11. Download and save the Signing Certificate to a text file.

  12. Copy and save the IDP Login URL for later use in the CCAI Platform Portal.

  13. Navigate to the Service Provider Configuration (SPC) section and select Manual Configuration:

  14. Under SP Entity ID / Issuer / Audience, enter: https://<environmentname>.ujet.co/saml/v1/metadata

  15. Under Assertion Consumer Service (ACS) URL, enter: https://<environmentname>.ujet.co/saml/v1/consume

  16. Beside Recipient, select Same as ACS URL.

  17. From the NameID Format drop-down, select emailAddress, then click Save:

  18. On the SAML Web App page, click the Permissions tab:

  19. Click Add.

  20. In the Select User, Group, or Role dialog, search for and select a user, then click Add.

  21. Click Save to deploy the SAML Web App:

Enable external authorization/SSO in the CCAI Platform Console

  1. Navigate to the CCAI Platform Console.

  2. Choose your project from the drop-down menu at the top of the page. You can either choose an existing instance or create a new one.

  3. Under Base details for your instance, select SAML.

  4. Under Entity ID, paste the IDP Entity ID you copied from the Idaptive portal.

  5. Under SSO URL, paste the IDP Login URL you copied from the Idaptive portal.

  6. Under Email Field Mapping enter NameID.

  7. In the Certificate text box, copy the contents of the downloaded Signing Certificate file from your text editor. Make sure "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----" are included.

  8. Click Create (new instance) or Save (pre-existing instance).

Verify Idaptive authentication

  1. Navigate to the CCAI Platform adapter in your CRM application. The CCAI Platform Agent Adapter login page is displayed:

  2. Click Login with Company SSO. A pop-up window is displayed, prompting you to log in with the Idaptive credentials:

  3. After successfully logging in to the Agent Adapter in the CRM, open a new private (incognito) tab in your web browser and navigate to the CCAI Platform Portal:

  4. Click Login with Company SSO and log in with your Idaptive credentials:

  5. Repeat the login verification steps multiple times to ensure the SAML SSO authentication works without any errors. On successful verification, you can log out of the CCAI Platform Portal, retaining the Login Policy updates.

SSO: Okta (SAML)

  1. In the Okta Admin Dashboard, Go to Applications > Applications

  2. Click Create App Integration

  3. Select SAML 2.0, then Click Next.

  4. Click Next.

  5. Specify a Name and Logo.

  6. Click Next.

  7. On the Configure SAML screen enter these values:

    Single sign on URL: https://<environmentname>.domain.co/saml/v1/consume

    Check Use this for Recipient URL and Destination URL

    Audience URI (SP Entity ID): https://<environmentname>.domain.co/saml/v1/metadata

    Name ID format: customer provides, (For example, EmailAddress)

  8. On the Feedback panel provide feedback selections.

    Suggested selections:

    I'm an Okta customer adding an internal app

    This is an internal app that we have created

  9. Click Finish.

  10. On the Sign On tab of the page that displays, click the View Setup Instructions button to launch a new tab.

Enable external auth/SSO in the CCAI Platform Console

  1. Navigate to the CCAI Platform Console.

  2. Choose your project from the drop-down menu at the top of the page. You can either choose an existing instance or create a new one.

  3. Under Login configuration for your instance, select SAML.

  4. Under Entity ID, paste the Identity Provider Issuer value from the Okta page.

  5. Under SSO URL, paste the Identity Provider Single Sign-On URL value from the Okta page.

  6. Keep the Email Field Mapping value set to NameID. If issues occur, try EmailAddress if that is what you have selected for the Name ID format in their Okta settings; this is generally unnecessary. NameID is fairly common.

  7. Download or copy the X.509 Certificate from the Okta page and paste into the Certificate field.

  8. Click Create (new instance) or Save (pre-existing instance).

Optional

  • Enable the disable-email-invites feature flag to turn off email notifications to new CCAI Platform users when accounts are created. This email is typically invalid when using SSO.

  • Disable the Forgot Password functionality for all CCAI Platform users except those with Admin permissions.

SSO: OneLogin (SAML)

  • In the CCAI Platform Portal, invite a user and ensure the user is also invited to the OneLogin app with the same email address.

  • Ensure you have a OneLogin Admin account: https://www.onelogin.com/

  • Create a SAML application for CCAI Platform, but first ensure you are in the administration portal by clicking Administration.

  1. Click Applications > Applications.

  2. Click Add App.

  3. Search for saml.

  4. Select the SAML Custom Connector (Advanced), or another SAML app you want to use.

  5. Click Configuration.

  6. Set end points.

  7. Click Save.

  8. Open the SSO page from the menu.

  9. Select the desired SAML Signature Algorithm.

  10. Copy the Issuer URL and the SAML 2.0 Endpoint (HTTP) in OneLogin and save for later use.

  11. Click View Details.

  12. Copy the X.509 Certificate and save for later use.

  13. Navigate to User > Users.

  14. Select a user.

  1. Click Applications.

  2. Click the + icon to add the SAML Custom Connector (Advanced) application.

Enable external auth/ SSO in the CCAI Platform Console

  1. Navigate to the CCAI Platform Console.

  2. Choose your project from the drop-down menu at the top of the page. You can either choose an existing instance or create a new one.

  3. Under Base details for your instance, select SAML.

  4. Under Entity ID, paste the Issuer URL value.

  5. Under Login URL, paste the SAML 2.0 Endpoint (HTTP).

  6. Keep the Email Field Mapping value set to NameID.

  7. Paste the X.509 Certificate into the Certificate field..

  8. Click Create (new instance) or Save (pre-existing instance).