> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloud.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UM SaaS Cloud

export const title_10 = "UM SaaS Cloud";

export const title_9 = "UM SaaS Cloud";

export const title_8 = "UM SaaS Cloud";

export const title_7 = "UM SaaS Cloud";

export const title_6 = "UM SaaS Cloud";

export const title_5 = "UM SaaS Cloud";

export const title_4 = "UM SaaS Cloud";

export const title_3 = "UM SaaS Cloud";

export const title_2 = "UM SaaS Cloud";

export const title_1 = "UM SaaS Cloud";

export const title_0 = "UM SaaS Cloud";

## Prerequisites

The **OAuth**, **OAuthClient**, **OAuthPassword**, and **AzureAD** authentication methods require a custom OAuth application. The default **OAuthPKCE** method uses CData's embedded OAuth application, so you can skip this section if you are using it.

To create a custom OAuth application in UM SaaS Cloud, follow these steps:

<Steps>
  <Step>
    Log in to your Salesforce org (the org where UM SaaS Cloud is installed) and navigate to **Setup**. In the **Quick Find** box, search for *Apps*, then click **New Connected App**.
  </Step>

  <Step>
    Enter a **Connected App Name** (the display name shown on the authentication dialog) and a **Contact Email**.
  </Step>

  <Step>
    Under **API (Enable OAuth Settings)**, select **Enable OAuth Settings** and set the **Callback URL** to *[https://oauth.cdata.com/oauth/](https://oauth.cdata.com/oauth/)*.
  </Step>

  <Step>
    Select the **OAuth scopes** that your application should request from the user, then **Save** the application.
  </Step>

  <Step>
    Open the connected app's settings to retrieve the **Consumer Key** (your **OAuth Client Id**) and **Consumer Secret** (your **OAuth Client Secret**). You enter these values in Connect AI when configuring the connection.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect UM SaaS Cloud to your Connect AI account:

<Steps>
  <Step>
    On the **Basic Settings** tab of the UM SaaS Cloud connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Set the **Use Sandbox** field to **True** (if you are connecting to a sandbox account). Otherwise, leave it as **False**.
  </Step>

  <Step>
    Select the Authentication method, then proceed to the relevant section and follow those instructions.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuthPKCE">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the UM SaaS Cloud sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your UM SaaS Cloud account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_0} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Basic">
    <Steps>
      <Step>
        Enter the UM SaaS Cloud username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuth">
    <Steps>
      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the UM SaaS Cloud sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your UM SaaS Cloud account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_2} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthClient">
    <Steps>
      <Step>
        Enter the **OAuth Client Id** (also known as the consumer key) assigned to your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_3} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthPassword">
    <Steps>
      <Step>
        Enter the UM SaaS Cloud username for authentication.
      </Step>

      <Step>
        Enter the user **Password**.
      </Step>

      <Step>
        Enter a **Security Token**. This step is mandatory unless your IP has been added to 'Trusted IP Addresses' in Salesforce already.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_4} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OAuthJWT">
    <Steps>
      <Step>
        Enter your **OAuth JWT Cert**. This is multi-line and in PEM format.
      </Step>

      <Step>
        Select the **OAuth JWT Cert Type**, which is the type of key store containing the JWT Certificate.
      </Step>

      <Step>
        Enter the **OAuth JWT Issuer**. This must include the client\_id or connected app for which the certificate is registered.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Password**. If the certificate store does not require a password, leave this field blank.
      </Step>

      <Step>
        (Optional) Enter an **OAuth JWT Cert Subject**, which identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. The wildcard '\*' selects the first certificate.
      </Step>

      <Step>
        (Optional) **OAuth JWT Subject** contains the user subject for which the application is requesting delegated access. It is only required if you are implementing for an Experience Cloud site.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_5} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="OneLogin">
    <Steps>
      <Step>
        Enter the OneLogin **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_6} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PingFederate">
    <Steps>
      <Step>
        Enter the PingFederate **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_7} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Okta">
    <Steps>
      <Step>
        Enter the Okta **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_8} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="ADFS">
    <Steps>
      <Step>
        Enter the ADFS **User** Id.
      </Step>

      <Step>
        Enter the **Password** for that account.
      </Step>

      <Step>
        Enter the **SSO Login URL**, the identity provider's login URL.
      </Step>

      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_9} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="AzureAD">
    <Steps>
      <Step>
        Enter the **SSO Properties**, with the format 'ssoproperty1=value1;ssoproperty2=value2;ssoproperty3=value3;'. Make sure to separate all property-value pairs with semicolons.
      </Step>

      <Step>
        Enter the **SSO Exchange URL**. You can find this in the UM SaaS Cloud account settings by navigating to **Administration Setup > Security Controls > SAML Single Sign-On Settings** and locating the OAuth 2.0 Token endpoint under your organization.
      </Step>

      <Step>
        Enter the **OAuth Client Id** assigned when you registered your custom OAuth application.
      </Step>

      <Step>
        Enter the **OAuth Client Secret** assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the UM SaaS Cloud sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your UM SaaS Cloud account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_10} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>