Connect a third-party data source

This page describes how to connect third-party data sources to Vertex AI Search.

When you connect a third-party data source, Vertex AI Search creates a data connector, and associates data stores (called entity data stores) with it for the entities that you specify. Entity types are specific to the data source that you're connecting to. For example, Jira Cloud entities include issues, attachments, comments, and worklogs.

Third-party data sources are available only for generic search apps. Chat, recommendations, and agent apps can't use third-party data sources.

Third-party connectors are not CMEK-compliant.

To import data from a Google data source instead, see Create a search data store.

Before you begin

  1. Contact your Google account team and ask to be added to the allowlist for third-party data source connectors.

  2. Go to the section for the source you plan to use:

Connect Adobe Experience Manager

Use the following procedure to sync data from Adobe Experience Manager to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • An Adobe Experience Manager administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Service credentials of your Adobe Experience Manager instance.
    • Instance URL of your Adobe Experience Manager site.

Create a Adobe Experience Manager connector

Console

To use the Google Cloud console to sync data from Adobe Experience Manager to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Adobe Experience Manager.

  5. Enter your Adobe Experience Manager authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect AODocs

Use the following procedure to sync data from AODocs to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • An AODocs administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Instance ID. Domain URL of your AODocs instance.
    • Client ID.
    • Client secret.

Create a AODocs connector

Console

To use the Google Cloud console to sync data from AODocs to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select AODocs.

  5. Enter your AODocs authentication information and click Authenticate. A new window appears.

  6. Authenticate your account and confirm that it succeeded before returning to the Specify the AODocs source for your data store page.

  7. Select which entities to sync and click Continue.

  8. Select a region for your data store.

  9. Enter a name for your data connector.

  10. Select a synchronization frequency.

  11. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  12. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect Box

Use the following procedure to sync data from Box to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • Have the following Box authentication information ready. For information about setting up these parameters, see JWT Auth in the Box developer documentation.

    • Enterprise ID
    • Client ID
    • Client secret
    • Public key ID
    • Private key
    • Passphrase

  • When creating the JWT endpoint, configure the following scopes:

Incremental changes for comments can take longer to sync than the configured frequency interval. If a folder containing an entity is copied or moved, then incremental changes can take longer to sync than the configured frequency interval.

Create Box app

  1. Sign in to the Box Developer Console with your administrator account.
  2. Click Create new app.
  3. Select Custom app type.
  4. Enter the App name.
  5. Set the Purpose of the app: Integration, AI, or Google Cloud Agent Builder.
  6. Choose Server authentication with JWT.

Configure Box app

Configure the settings for your Box app.

Create public/private key

  1. Go to the Box Developer Console.

  2. In the Configuration tab, click Generate a public/private keypair.

    • The public key is automatically uploaded to the console with an ID. This ID is used when creating a connection.
    • A configuration file with the private key and passphrase can be downloaded locally. Make sure to keep this configuration file for later use.
    • Optionally, to generate your own key see the Box keypair setup guide.

Configure required permissions

  1. In the Application scopes section, select the following permission:
    • Read all files and folders stored in Box.

Authorize the app

  1. In the Authorization tab, click Review and submit and wait for approval from your administrator.
  2. Administrators can approve the app in the Admin console.

After authorization, Box fully sets up the app.

Create a Box connector

Console

To use the Google Cloud console to sync data from Box to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, scroll or search for Box to connect your third-party source.

  5. Enter your authentication information.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data store.

  9. Select a synchronization frequency for your data store.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Coda

Use the following procedure to sync data from Coda to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • A Coda administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Coda API token.

Create a Coda connector

Console

To use the Google Cloud console to sync data from Coda to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Coda.

  5. Enter your Coda authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect Confluence Cloud

Use the following procedure to sync data from Confluence Cloud to Vertex AI Search.

After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.

Before you begin

Before setting up your connection:

  • Verify that you have administrator access to the Confluence instance and project.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

Set up authentication and permissions in Confluence

Using the instructions in the following sections, ensure you have the necessary authentication details and administrator access to your Confluence instance. Create a Client ID and Client Secret through the Atlassian Developer Console, configure the required OAuth 2.0 scopes, and set up permissions for users. Retrieve your instance URL and ID, configure roles, and authenticate to sync data between Confluence Cloud and Vertex AI Search.

- Instance ID. This is the `cloudid` and is available on
  <code>https://<var>EXAMPLE</var>.atlassian.net/_edge/tenant_info</code>
  and copying the value of `cloudId`.
  • Enable OAuth 2.0 and get the client ID and client secret.
    • Go to Confluence API.
    • Click Add.

    • Click Configure.

      b. Go to the Granular scopes tab and click Edit scopes. Select the following scopes:

    Confirm that 7 scopes are selected, then save your changes.

  1. Click Distribution.

  2. Select Edit, and do the following:

    • Select Sharing to enable editing other fields.
    • Fill out the remaining fields.
    • Select Yes when you see Does your app store personal data?

  3. Select Settings to copy your Client ID and Client Secret.

Retrieve instance URL and instance ID

Obtain the instance URL:

  1. Go to atlassian.net and sign in with your administrator account.
  2. Select the app you want to sync. For example, sync the first app.
  3. Find the instance URL, which is the subdomain in the address bar.

Obtain the instance ID:

  1. Open a new tab, copy the instance URL, and append /_edge/tenant_info to the instance URL. For example, https://YOUR-INSTANCE.atlassian.net/_edge/tenant_info.
  2. Navigate to the link to find the cloudId value. The cloudId is your instance ID.

Set up permissions and roles

To grant Confluence administrator the Discovery Engine editor role, do the following:

  1. Go to your Atlassian domain site and open the Confluence Cloud instance.
  2. Navigate to IAM .
  3. Grant the Confluence administrator the Discovery Engine role. This allows the Confluence administrator to configure the connector as outlined in Create a Confluence Cloud connector.

To grant a user the administrator role, do the following:

  1. Create a dedicated user account.
  2. Assign the Admin role to the new user.
    • Use this account for data store setup.

To configure permissions in Atlassian, do the following:

  1. Go to your Atlassian domain site and open the Confluence Cloud instance.
  2. Click the menu icon and select the required option.
  3. (Optional) If prompted, select the appropriate organization from the landing page.

To create and configure groups, do the following:

  1. On the Administrator page, click the Manage users button (if required).
    • Select Manage users from the drop-down list.
  2. On the User management page, select Groups.
  3. Click Create group and assign a name.
    • Use this group for assigning permissions required by the connector.
  4. Add permissions to the group: Assign the User access admin role.

To assign group members, do the following:

  1. On the Group page, click Add product and select the appropriate product role:
    • User access admin
  2. Click Add to confirm role assignment.
  3. Click Add group members to include user accounts or group members.
    • Ensure the connector authenticates on behalf of these users to fetch documents.

For user permissions to apply correctly, each Confluence Cloud user must make their email visible to all users. To achieve this, change the email visibility settings in Confluence Cloud and set the visibility to Anyone. For more information, see Set your email visibility in the Atlassian documentation.

Create a Confluence Cloud connector

Console

To use the Google Cloud console to sync data from Confluence Cloud to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click New data store.

  4. On the Select a data source page, go to the Third-party sources section and select Confluence.

  5. Enter your authentication information and click Authenticate.

  6. A new window appears. Enter the instance username and password. Check that the authentication succeeded before returning to the Specify the Confluence source for your data store page.

  7. Select which entities to sync, then click Continue.

  8. Select a region for your data connector.

  9. Enter a name for your data connector.

  10. Select a synchronization frequency.

  11. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data Stores page.

  12. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Confluence Data Center On-premises

Use this procedure to create a Confluence Data Center data store and search app in Agent Builder, syncing on-premises Confluence data with Vertex AI Search.

After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.

Before you begin

Before setting up your connection, make sure that you have the following:

  • Service attachment (Required for private destination type only): Configure a service attachment for secure data transfer.
  • Username and password: Obtain valid credentials for authentication from your Confluence administrator.
  • Domain URL (Optional for private destination type): Specify the URL of the Confluence Data Center instance.
  • Base domain name (Optional): Provide the base domain name for the Confluence instance.
  • Destination port (Optional): Identify the port used for communication with the Confluence Data Center.

Configuration guidelines for Private Service Connect

Use the following configuration guidelines to establish connections with Private Service Connect(PSC). Adjust or add resources as needed. Make sure the PSC service attachment is properly configured to connect to the private instance and meets the requirements for a published service.

  • Network configuration:

    a. Place the PSC service attachment and load balancer in different subnets within the same Virtual Private Cloud network.

    b. The backend system must remain closed to the public network for security reasons. However, ensure it can accept traffic from the following sources:

    • For proxy-based/HTTP(s) load balancers (L4 proxy ILB, L7 ILB), configure the backend to accept requests from the proxy subnet in the Virtual Private Cloud network.
    • For more information, see the Proxy-only subnets for Envoy-based load balancers documentation.

  • Firewall rules:

    a. Ingress rules:

    • Allow traffic from the PSC service attachment subnet to the Internal Load Balancer (ILB) subnet.
    • Make sure that the ILB can send traffic to the backend.
    • Permit health check probes to reach the backend.

    b. Egress rules:

    • Enable egress traffic by default, unless specific deny rules apply.

Additional considerations:

  • Make sure to keep all the components, including the PSC service attachment and load balancer, in the same region.

Generate a service attachment

Use the following steps to generate a service attachment:

  1. Decide endpoint type: Select Public or Private endpoint.

  2. For Public endpoint: If the Confluence Data Center Destination type is Public, you are not required to create the setup for service attachment. Instead, you can use your public URL in the Domain URL field of the Google Cloud console when creating your connector.

  3. For Private endpoint:

    a. Use Private Service Connect (PSC) to enable connections from private instances to Google Cloud.

    b. Create a Virtual Private Cloud network and required subnets.

    c. Create a Virtual Machine (VM) instance and install the backend service.

    d. (Optional) Set up a health check probe to monitor backend health.

    e. Add a load balancer to route traffic to the VM or backend.

    f. Define firewall rules to allow traffic between the PSC endpoint and the backend.

    g. Publish the endpoint by creating a PSC service attachment.

Create a Confluence Data Center user and set up permissions

To enable Vertex AI Search to obtain data from Confluence, you need to create a new user with the minimum permissions necessary. Follow these steps to create the user and set up the required permissions.

Sign in as an administrator
  1. Go to your Atlassian domain site and open the Confluence Data Center instance.
  2. Enter the admin username and password.
  3. Click Log In.
Create a new user

When creating a data store, you must create a user to obtain data from the third-party instance.

  1. Click the settings icon.
  2. Select User management.
  3. Enter the administrator credentials, if prompted.
  4. In the Administration page, click Create user.
  5. Enter the email address, full name, username, and password.
  6. Click Create user.
Assign user to a group
  1. In the Confluence administration page, navigate to the Users and security tab and click Groups.
  2. Click Add group. Enter a name for the group and create it.
  3. In the Find group field, enter the group name to find the group.
  4. Click the settings icon.
  5. Select the profile account and navigate to User management.
  6. In the Users page, under List users, search for the newly created user in the Find user field.
  7. Click the user to open the View users page.
  8. Click Edit groups to open the Edit user group page.
  9. Select the checkbox for the created user group.
  10. Click Save to assign the user to the newly created group.

The added user is assigned in the Group members section.

Configure user permissions
  1. In the Confluence administration page, navigate to the Issues tab.
  2. Locate Permissions.
  3. Select View global permissions.
  4. Select Edit permissions.
  5. In the Edit global permissions page, search for the group assigned to the user, and enable the can use option.

Configure the documentation space

  1. Click the Confluence icon to navigate to the Dashboard page.
  2. Click Create space
  3. Select Documentation space and click Next.
  4. Enter all the necessary details and click Create to create the documentation space.
  5. Under My spaces, click the newly created space.
  6. Navigate to Pages, and open the menu (three dots).
  7. Select Restrictions.
  8. From the Restrictions drop-down menu, select the Viewing and editing restricted option.
  9. Search for the group and assign the can view permission.
  10. Click Apply. The user is created with minimum access and permissions are set for spaces. You can also assign permissions to the blogs.

Set up a Confluence Data Center on-premises connector

Set up a Confluence Data Center on-premises connector to sync data with Google Cloud. First, create a data store in the Agent Builder and configure the connection settings, including authentication and synchronization preferences.

Create a Confluence Data Center On-premises connector

Console

To use the Google Cloud console to sync data from Confluence Cloud to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click New data store.

  4. On the Select a data source page, go to the Third-party sources section and select Confluence.

  5. Enter your authentication information and click Authenticate.

  6. A new window appears. Enter the instance username and password. Check that the authentication succeeded before returning to the Specify the Confluence source for your data store page.

  7. Select which entities to sync, then click Continue.

  8. Select a region for your data connector.

  9. Enter a name for your data connector.

  10. Select a synchronization frequency.

  11. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data Stores page.

  12. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Dropbox

Use the following procedure to sync data from Dropbox to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • Set up access control for your data source. For more information, see Use data source access control.

  • Have the following Dropbox authentication information ready. For information about setting up these parameters, see the OAuth Guide in the Dropbox documentation.

    • Client ID
    • Client secret

Console

To use the Google Cloud console to sync data from Dropbox to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data Stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Dropbox.

  5. Enter your Dropbox authentication information and click Authenticate. A new window appears.

  6. Authenticate your account and confirm that it succeeded before returning to the Specify the Dropbox source for your data store page.

  7. Select which entities to sync and click Continue.

  8. Select a location for your data store.

  9. Enter a name for your data store.

  10. Select a synchronization frequency for your data store.

  11. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  12. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization. Check the Documents tab to make sure your entities have been ingested correctly.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Dynamics 365

Use the following procedure to sync data from Dynamics 365 to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before you create a Dynamics 365 connector:

  • A Dynamics 365 administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Client ID
    • Client secret
    • Azure Tenant
    • Organization URL. For example, https://abc123.cloudax.dynamics.com/.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

Create a Dynamics 365 connector

Console

To use the Google Cloud console to sync data from Dynamics 365 to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Dynamics 365.

  5. Enter your Dynamics 365 authentication information and click Continue.

  6. Enter your Azure tenant and organization URL and click Continue.

  7. Select which entities to sync and click Continue.

  8. Select a region for your data store.

  9. Enter a name for your data connector.

  10. Select a synchronization frequency.

  11. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  12. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect GitHub

Use the following procedure to sync data from GitHub to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • A GitHub administrator must obtain the following for integrating with Vertex AI Search:

    • GitHub instance personal access token.

Create a GitHub connector

Console

To use the Google Cloud console to sync data from GitHub to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select GitHub.

  5. Enter your GitHub authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect GitLab

Use the following procedure to sync data from GitLab to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • A GitLab administrator must obtain the following for integrating with Vertex AI Search:

    • GitLab instance personal access token.

Create a GitLab connector

Console

To use the Google Cloud console to sync data from GitLab to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select GitLab.

  5. Enter your GitLab authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect Jira Cloud

Use the following procedure to sync data from Jira Cloud to Vertex AI Search.

After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.

Before you begin

Before setting up your connection:

  • Verify that you have administrator access to the Jira instance, and project.
  • Set up access control. Ensure that access control is properly configured for your data source. This step ensures that only authorized users can access and manage the data. For more information, see Use data source access control documentation.
  • For user permissions to apply correctly, Jira Cloud users must provide sharing consent.
  • Make sure that you have an Atlassian account, Jira instance, and project.

Set up authentication and permissions in Jira

Use the instructions in the following sections to ensure that you have the necessary authentication details and administrator access to your Jira instance. Create a Client ID and Client Secret through the Atlassian Developer Console, configure the required OAuth 2.0 scopes, and set up permissions for users. Retrieve your instance URL and ID, configure roles, and authenticate to sync data between Jira Cloud and Vertex AI Search.

Create client ID and client secret

To enable OAuth 2.0 and obtain the client ID and secret, see OAuth 2.0 (3LO)apps in the Atlassian Developer documentation.

To create an OAuth 2.0 integration in the Atlassian Developer console, do the following:

  1. Sign in to developer.atlassian.com.
  2. Click the profile icon in the top right corner and select Developer Console.
  3. Click Create and select OAuth 2.0 Integration.

  4. Enter a name for the app.

    • Check the terms and conditions checkbox.
    • Click Create.
    • Click Authorization.
    • In the Authorization type table, select Add for OAuth 2.0 (3LO).

  5. In the Callback URL field, enter https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html.

  6. Click Save changes.

If you see the warning: Your app doesn't have any APIs. Add APIs to your app, do the following:

  1. Select Permissions:

    • Go to Jira API.
    • Click Add.
    • Click Configure.
    • Go to the Classic scopes tab and click Edit scopes. Select the following scopes:

    Confirm that 8 scopes are selected, then save your changes.

  2. Click Distribution.

  3. Select Edit, and do the following:

    • Select Sharing to enable editing other fields.
    • Fill out the remaining fields.
    • Select Yes when you see Does your app store personal data?

  4. Select Settings to copy your Client ID and Client Secret.

Retrieve instance URL and instance ID

Obtain the instance URL:

  1. Go to atlassian.net and sign in with your administrator account.
  2. Select the app you want to sync. For example, sync the first app.
  3. Find the instance URL, which is the subdomain in the address bar.

Obtain the instance ID:

  1. Open a new tab, copy the instance URL, and append /_edge/tenant_info to the instance URL. For example, https://YOUR-INSTANCE.atlassian.net/_edge/tenant_info.
  2. Navigate to the link to find the cloudId value. The cloudId is your instance ID.

Set up permissions and roles

  1. Sign in to atlassian.com with your administrator account.
  2. Click the menu icon on the top left or go to admin.atlassian.com.
  3. On the Admin page, click Manage users and go to the Groups page.
  4. Click Create group. Enter a name for the group and create it.
  5. Click Add product.
  6. On the Add products to group dialog, select User access admin as the product role.
  7. Click Add.
  8. On the Groups page, click Add group members to add users or accounts that the connector authenticates.

For user permissions to apply correctly, each Jira Cloud user must make their email visible to all users. To achieve this, change the email visibility settings in Confluence Cloud and set the visibility to Anyone. For more information, see Set your email visibility in the Atlassian documentation.

Create a Jira Cloud connector

Console

To use the Google Cloud console to sync data from Jira Cloud to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data Stores.

  3. Click Create data store.

  4. On the Select a data source page, scroll or search for Jira to connect your third-party source.

  5. Enter your authentication information and click Authenticate.

  6. Enter the instance username and password.

  7. Verify that the authentication succeeded before returning to the Specify the Jira source for your data store page.

  8. Select which entities to sync, then click Continue.

  9. Select a region for your data store.

  10. Enter a name for your data store.

  11. Select a synchronization frequency.

  12. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data Stores page.

  13. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Jira Data Center On-premises

Use this procedure to create a Jira Data Center data store and search app in Agent Builder, syncing on-premises Jira data with Vertex AI Search.

After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.

Before you begin

Before setting up your connection, make sure that you have the following:

  • Service attachment (Required for private destination type only): Configure a service attachment for secure data transfer.
  • Username and password: Obtain valid credentials for authentication from your Jira administrator.
  • Domain URL (Optional for private destination type): Specify the URL of the Jira Data Center instance.
  • Base domain name (Optional): Provide the base domain name for the Jira instance.
  • Destination port (Optional): Identify the port used for communication with the Jira Data Center.

Configuration guidelines for Private Service Connect

Use the following configuration guidelines to establish connections with Private Service Connect(PSC). Adjust or add resources as needed. Make sure the PSC service attachment is properly configured to connect to the private instance and meets the requirements for a published service.

  • Network configuration:

    a. Place the PSC service attachment and load balancer in different subnets within the same Virtual Private Cloud network.

    b. The backend system must remain closed to the public network for security reasons. However, ensure it can accept traffic from the following sources:

    • For proxy-based/HTTP(s) load balancers (L4 proxy ILB, L7 ILB), configure the backend to accept requests from the proxy subnet in the Virtual Private Cloud network.

    • For more information, see the Proxy-only subnets for Envoy-based load balancers documentation.

  • Firewall rules:

    a. Ingress rules:

    • Allow traffic from the PSC service attachment subnet to the Internal Load Balancer (ILB) subnet.
    • Make sure that the ILB can send traffic to the backend.
    • Permit health check probes to reach the backend.

    b. Egress rules:

    • Enable egress traffic by default, unless specific deny rules apply.

Additional considerations:

  • Make sure to keep all the components, including the PSC service attachment and load balancer, in the same region.

Generate a service attachment

Use the following steps to generate a service attachment:

  1. Decide endpoint type: Select Public or Private endpoint.

  2. For Public endpoint: If the Jira Data Center Destination type is Public, you are not required to create the setup for service attachment. Instead, you can use your public URL in the Domain URL field of the Google Cloud console.

  3. For Private endpoint:

    a. Use PSC to enable connections from private instances to Google Cloud.

    b. Create a Virtual Private Cloud network and required subnets.

    c. Create a Virtual Machine (VM) instance and install the backend service.

    d. (Optional) Set up a health check probe to monitor backend health.

    e. Add a load balancer to route traffic to the VM or backend.

    f. Define firewall rules to allow traffic between the PSC endpoint and the backend.

    g. Publish the endpoint by creating a PSC service attachment.

Create a Jira Data Center user and set up permissions

To enable Vertex AI Search to obtain data from Jira, you need to create a new user with the minimum permissions necessary. Follow these steps to create the user and set up the required permissions.

Sign in as an administrator
  1. Go to your Atlassian domain site and open Jira Data Center instance.
  2. Enter the admin username and password.
  3. Click Log In.
Create a new user

When creating a data store, you must create a user to obtain data from the third-party instance.

  1. Click the settings icon.
  2. Select User management.
  3. Enter the administrator credentials, if prompted.
  4. In the Administration page, click Create user.
  5. Enter the email address, full name, username, and password.
  6. Click Create user.
Assign user to a group
  1. In the Administration page, under User management, click Groups.
  2. Create a group by entering a name and clicking Add group.
  3. Select the newly created group.
  4. Click Add/Remove users.
  5. Click the member icon located next to the Add members to selected groups box.
  6. Select the newly created user and click Save the selection.
  7. Click Add selected user to see new users in the group members section.

You can see the added user is assigned in the Group members section.

Configure user permissions
  1. In the Administration page, navigate to the Issues tab.
  2. Select Permission schemes.
  3. Click Add permission scheme.
  4. Enter a name for the scheme and click Add.
  5. Select the scheme and click the Permission icon.
  6. Click Grant permission.
  7. Add the following permissions, assign these permissions to the group created earlier, and click Grant:
    • Browse projects.
    • Browse projects archive.

You can add this scheme to the projects where the users in that group need access to view that project and issues, comments, worklogs, and attachments in that project.

Configure application access

  1. In the Administration page, navigate to the Applications tab.
  2. Under the Applications tab, select Application access.
  3. Search for the created group and select it.
  4. Verify that the group appears in the access list.

The user is created with minimum access. This schema is added to the projects. The Jira administrator can add more members to that group or add users to that project.

Set up a Jira Data Center on-premises connector

Set up a Jira Data Center on-premises connector to sync data with Google Cloud. First, create a data store in the Agent Builder and configure the connection settings, including authentication and synchronization preferences.

Create a Jira Data Center On-premises connector

Console

To use the Google Cloud console to sync data from Jira Cloud to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data Stores.

  3. Click Create data store.

  4. On the Select a data source page, scroll or search for Jira to connect your third-party source.

  5. Enter your authentication information and click Authenticate.

  6. Enter the instance username and password.

  7. Verify that the authentication succeeded before returning to the Specify the Jira source for your data store page.

  8. Select which entities to sync, then click Continue.

  9. Select a region for your data store.

  10. Enter a name for your data store.

  11. Select a synchronization frequency.

  12. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data Stores page.

  13. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Microsoft Outlook

Use the following procedure to sync data from Microsoft Outlook to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • A Microsoft Outlook administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Client ID.
    • Client secret.
    • Tenant ID.

Create a Microsoft Outlook connector

Console

To use the Google Cloud console to sync data from Microsoft Outlook to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Microsoft Outlook.

  5. Enter your Microsoft Outlook authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect Microsoft Teams

Use the following procedure to sync data from Microsoft Teams to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • A Microsoft Teams administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Client ID.
    • Client secret.
    • Tenant ID.

Create a Microsoft Teams connector

Console

To use the Google Cloud console to sync data from Microsoft Teams to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Microsoft Teams.

  5. Enter your Microsoft Teams authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect Notion

Use the following procedure to sync data from Notion to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connector:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • A Notion administrator must generate or obtain the following for integrating with Vertex AI Search:

    • API token of the Notion instance.
    • Workspace ID.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

Create a Notion connector

Console

To use the Google Cloud console to sync data from Notion to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Notion.

  5. Enter your Notion authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect OneDrive

Use the following procedure to sync data from OneDrive to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

Console

To use the Google Cloud console to sync data from OneDrive to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select OneDrive.

  5. Enter your OneDrive authentication information.

  6. Select which entities to sync and cick Continue.

  7. Select a region for your data store.

  8. Enter a name for your data store.

  9. Select a synchronization frequency for your data store.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Salesforce

Use the following procedure to sync data from Salesforce to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

The following limitation applies:

Create a Salesforce connector

Console

To use the Google Cloud console to sync data from Salesforce to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, scroll or search for Salesforce to connect your third-party source.

  5. Enter your Salesforce authentication information.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data store.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect ServiceNow

Use the following procedure to sync data from ServiceNow to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection, ensure you have the following in place:

  • ServiceNow instance: Create a ServiceNow instance by following the instructions on the ServiceNow Developer documentation.

  • Google Cloud project: Set up a Google Cloud project with an admin account capable of managing organization-level configurations, ensuring the organization can set up a workforce pool.

  • Workforce pool: Make sure your organization is set up to manage a workforce pool.

Set up ServiceNow

ServiceNow offers two primary sites:

  1. Main ServiceNow site: The site for your ServiceNow instance.

    • Manages users, groups, and system administration tasks.
    • URL: The URL for your ServiceNow instance.
    • Sign in using your admin credentials.

  2. Developer site:

    • Configures the knowledge base, workflows, and developing custom applications.
    • URL: https://developer.service-now.com.
    • Sign in using your ServiceNow ID.

Create an OAuth endpoint

  1. Sign into the main ServiceNow instance with admin privileges.
  2. Navigate to All > System OAuth > Application registry.
  3. Click New, then select Create an OAuth API endpoint for external clients. Retrieve the client ID and client secret.

  4. Fill in the required information:

    • Name: Unique name.
    • Redirect URL: https://vertexaisearch.cloud.google.com/console/oauth/servicenow_oauth.html.

  5. Click Submit to create the credential.

  6. After submission, click the name to view the client secret.

  7. The secret is masked. Click the lock icon next to it to unmask and view the secret.

  8. Keep a copy of the client ID and secret to use when required.

  9. Go to developer.service-now.com and click Manage instance password.

  10. Keep a copy of the username and password to use when required.

  11. At this stage, all five pieces of information needed to set up a ServiceNow data store are available. If there are no concerns with using the Admin role to pull data, proceed to creating a data store.

Set up roles and permissions

You must have a security Admin role to create and manage users. If you don't have this role, do the following:

  1. Elevate your role to security_admin by clicking Elevate role under your profile.

  2. Select the security_admin role and click Update. The security_admin role is required to create roles and manage users.

Create a custom role with ACL rules
  1. Navigate to All > User administration > Roles.
  2. Click New to create a new role.
  3. Select a name and click Submit.
  4. Navigate to System security > Access Control (ACL) to create a new ACL rule.
  5. Click New to create a new ACL rule.
  6. Select a role, such as sys_user_role.
  7. Click Submit and assign the role.

  8. Repeat this process until all the table access is granted. The connector requires access to the following tables for each entity to run successfully:

    • Incident: incident.
    • Catalog item: sc_cat_item, sc_cat_item_user_criteria_mtom, sc_cat_item_user_criteria_no_mtom, sc_cat_item_user_mtom, sc_cat_item_user_no_mtom.
    • Knowledge: kb_knowledge, kb_knowledge_base, kb_uc_can_read_mtom, kb_uc_can_contribute_mtom.
    • Attachment: All listed items.
    • Identity: sys_user_role, sys_user_has_role, sys_user_group, sys_user_grmember, sys_user.
    • Updated as new criteria are pulled: core_company, cmn_location, cmn_department.
    • User criteria: user_criteria.

  9. Verify all ACLs are updated by navigating to sys_security_acl_role_list.do in the search bar.

  10. Select the role to verify.

  11. Confirm that all the required ACLs are assigned to the selected role.

Grant the role to a service account

  1. Go to All > User Administration > Users and select the user.
  2. Find the user to grant the role to and select the user.
  3. If no user is available, navigate to System security > Users and groups > Users.
  4. Click New to create a new service account in the User table.
  5. Ensure to check the Web service access only checkbox.
  6. Go to the Roles table at the bottom of the page.
  7. Click Edit on the right.
  8. Grant the role created earlier and assign it to the user. Depending on the type of role created, select the appropriate one and assign it.
  9. Obtain the username and password for the user. From the same page, click Set password.

  10. Auto-generate a password and save it for later use:

    • User ID: manager.
    • Password: Enter the auto-generated password.

Configure workforce pool

Follow the instructions to set up a workforce pool with one of the following configurations:

Create a ServiceNow connector

Console

To use the Google Cloud console to sync data from ServiceNow to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select ServiceNow.

  5. Enter your ServiceNow authentication information.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data connector.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your data connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect SharePoint Online

Use the following procedure to sync data from SharePoint Online to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • Grant administrator consent. For information about how to grant consent, see Grant tenant-wide administrator consent to an application in the Microsoft documentation.

  • Prepare the following Sharepoint Online authentication information to use during setup:

    • Instance URL. In the form http://DOMAIN_OR_SERVER/[sites/]WEBSITE.

    • Federated authentication requires the tenant ID and client ID, while OAuth requires the tenant ID, client ID, and client secret. To register the application, select Accounts in this organizational directory only for the sign-in audience, and then locate this authentication information. For more information, see Quickstart: Register an application with the Microsoft identity platform in the Microsoft documentation.

    • When registering the application, use https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html as the web callback URL.

    • When configuring application permissions, add the following application permissions for Graph API:

    • When configuring application permissions, add the following delegated permissions for Sharepoint REST API:

  • The following table describes the roles that are recommended for configuration and their limitations.

Use this method for granular control over SharePoint REST API permissions, allowing you to restrict resource access on the user account. Make sure to create a new SharePoint user, which might add licensing costs. Use the [OAuth 2.0 refresh token](#oauth-2.0-refresh-token) method to set up an Entra application registration and enable secure access to SharePoint.

Configure Entra application registration

Set up an Entra application registration to enable secure access to SharePoint. Choose between Federated credentials for token-based access or OAuth 2.0 refresh token for granular control. Use the following steps to configure the app registration, grant permissions, and establish authentication.

Federated credentials

Set up federated credentials to securely allow Google to access SharePoint using cryptographically signed tokens, avoiding the need for a real user principal. To configure permissions and grant access, do the following:

  1. Obtain service account client ID:

    a. In the Google Cloud console, go to the Agent Builder page.

    b. In the navigation menu, click Data stores.

    c. Click Create data store.

    d. On the Select a data source page, go to the Third-party sources section and select SharePoint Online.

    e. Note the Subject Identifier.

  2. Register app in Microsoft Entra:

    a. Navigate to Entra admin center.

    b. Create an app registration:

    • Supported account types: Accounts in the organizational directory only.
    • Keep other settings default and click Register.

    c. Note the Client ID and Tenant ID.

  3. Add federated credentials:

    a. Go to Certificates & secrets > Federated credentials > Add credential.

    b. Use the following settings:

    • Issuer: https://accounts.google.com
    • Subject identifier: Use the noted subject identifier.
    • Name: Provide a unique name.

    c. Click Add to grant access.

  4. Set API permissions:

    a. Add and grant admin consent for the following permissions:

    • Graph API:

      • GroupMember.Read.All (Application): Read all group memberships.
      • Sites.Read.All (Application): Read all sites.
      • User.Read.All (Application): Read all users' full profiles.

    • SharePoint API:

      • Sites.FullControl.All (Application): Full control over all sites.

    b. Use Sites.Selected to assign specific site permissions instead of Sites.FullControl.All. Sites.Selected cannot be directly configured through the UI. After selecting Sites.Selected, you must call the Microsoft Graph API to explicitly grant the fullcontrol role to the application for the sites you want to crawl.

    c. Grant Sites.Read.All for crawling all subsites under a root site URL.

OAuth 2.0 refresh token

Configure OAuth 2.0 authentication using a client secret and a refresh token from the SharePoint user to enable granular control over SharePoint API access. To set up app registration, add a client secret, and assign API permissions, do the following:

  1. Create app registration:

    a. Navigate to Entra admin center.

    b. Create an app registration:

    • Supported account types: Accounts in the organizational directory only.
    • Redirect URI: https://vertexaisearch.cloud.google.com/console/oauth/sharepoint_oauth.html.

    c. Note the Client ID and Tenant ID.

  2. Add client secret:

    a. Go to Certificates & secrets > New client secret.

    b. Note the secret string.

  3. Set API permissions:

    a. Add and grant admin consent for the following permissions:

    • Graph API (Application):

      • GroupMember.Read.All: Read all group memberships.
      • Sites.FullControl.All: Full control of all site collections.
      • User.Read.All: Read all users' full profiles.

    • SharePoint REST API (Delegated):

      • AllSites.FullControl: Full control over all sites.

    b. Use a dedicated user account with limited access to specific sites.

    c. Make sure the account has Owner access to the selected sites.

Create a SharePoint Online connector

Set up a search engine by selecting SharePoint as the data source and configuring the appropriate authentication method. Choose between federated credentials for token-based access or OAuth 2.0 refresh token for more granular control, then provide the necessary site URL and app registration details to complete the process.

Console

To use the Google Cloud console to sync data from Sharepoint Online to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Sharepoint Online.

  5. Enter your Sharepoint Online authentication information and click Authenticate.

  6. Enter the SharePoint site URL:

    • For a single site: https://<domain_name>.sharepoint.com/sites/<site_name>.
    • For all first-level sites: https://<domain_name>.sharepoint.com.

  7. Select the entities to sync and click Continue.

  8. Select a region for your data store.

  9. Enter a name for your data store.

  10. Select a synchronization frequency for your data store.

  11. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  12. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Test the search engine

After configuring your search engine, test its capabilities. This ensures it returns accurate results based on user access.

  1. Enable web app:

    a. Go to the app integration configurations and toggle to Enable the web app.

  2. Test web app:

    a. Click Open next to the web app link and sign in with a user in your workforce pool.

    b. Verify that search results are restricted to items accessible by the logged-in user.

Configure workforce pool

The workforce pool lets you to manage and authenticate users from external identity providers, such as Azure or Okta, within Google Cloud console. To configure your workforce pool and enable the web app for seamless user access, do the following:

  1. Create workforce pool

    a. Create a workforce pool at the organization level in Google Cloud by following the appropriate setup manual:

    b. Configure the workforce pool in Agent Builder > Settings for the region where you create your app.

Next steps

Connect Slack

Use the following procedure to sync data from Slack to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • Contact the Workspace owner to provide the permissions to install new apps in your workspace.

  • Prepare the following Slack authentication information:

    • Workspace ID: Get the Workspace ID by following the instructions in Specify the Slack source for your data store in the Slack documentation.
    • Access token: Create a client app and define the required scopes. For more information, see Quickstart and How to quickly get and use a Slack API token in the Slack documentation.
    • When setting OAuth 2.0 permission scopes, configure the following scopes:

The following limitation applies:

  • Slack's default behavior restricts the crawling and syncing of content from private channels, multi-party instant messages, and 1:1 instant messages.

Console

To use the Google Cloud console to sync data from Slack to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, scroll or search for Slack to connect your third-party source.

  5. Enter your Slack authentication information.

    • Instance ID (Workspace ID): Obtain this from your Slack workspace by signing in through a browser. The workspace ID is the segment after /client in the URL.
    • Auth token: Use the token obtained from the previous section.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data store.

  9. Select a synchronization frequency for your data store.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take minutes or hours.

Next steps

Connect Trello

Use the following procedure to sync data from Trello to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connector, make sure that the following steps are completed:

  • Verify that you have Trello administrator access. A Trello administrator must generate an API key and token in the following section.
  • Check that your project is added to the allowlist to use Trello.
  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

Generate API key and token in Trello

A Trello administrator must perform the following steps:

  1. Create a Trello Power up for generating an API key.
  2. Go to the Trello Admin page.
  3. Navigate to the API Key tab and select the option to generate a new API key.
  4. Click Token.
  5. Click Allow.
  6. Copy the token.

For more information about Trello API, see API Introduction.

Create a Trello connector

Console

To use the Google Cloud console to sync data from Trello to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Trello.

  5. Enter your Trello authentication information and click Continue.

  6. Optional: To route HTTP traffic, click Add destination and enter the hostname or IP address of the proxy server. Then click Continue.

  7. Select which entities to sync and click Continue.

  8. Select a region for your data store.

  9. Enter a name for your data connector.

  10. Select a synchronization frequency.

  11. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  12. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect Workday

Use the following procedure to sync data from Workday to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before you create a Workday connector:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • A Workday administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Client ID. Obtain from the View API Clients page in Workday.
    • Client secret. Obtain from the View API Clients page in Workday.
    • Refresh token. Obtain from the View API Clients page in Workday.
    • (Optional) Proxy Server. The hostname or IP address of a proxy to route HTTP traffic through.
    • (Optional) Base URL. The base URL for the Workday connection.
    • (Optional) API URL. The complete URL to the API endpoint to use for making SOAP requests. For example: https://<var>host</var>.workday.com/ccx/service/<var>tenant</var>/<var>service</var>
    • Workday tenant. The tenant for the account. For example, abc_cms1. You can get the name of the tenant in your Workday instance configuration details.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

Create a Workday connector

Console

To use the Google Cloud console to sync data from Workday to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Workday.

  5. Enter your Workday authentication information and click Continue.

  6. Optional: Enter your Workday destination information and click Continue.

  7. Enter your Workday tenant and click Continue.

  8. Select which entities to sync and click Continue.

  9. Select a region for your data store.

  10. Enter a name for your data connector.

  11. Select a synchronization frequency.

  12. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  13. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps

Connect Zendesk

Use the following procedure to sync data from Zendesk to Vertex AI Search.

After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.

Before you begin

Before setting up your connection:

  • In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.

  • Set up access control for your data source. For information about setting up access control, see Use data source access control.

  • A Zendesk administrator must generate or obtain the following for integrating with Vertex AI Search:

    • Access token. API Token of your Zendesk instance.
    • Instance URI.

Create a Zendesk connector

Console

To use the Google Cloud console to sync data from Zendesk to Vertex AI Search, follow these steps:

  1. In the Google Cloud console, go to the Agent Builder page.

    Agent Builder

  2. In the navigation menu, click Data stores.

  3. Click Create data store.

  4. On the Select a data source page, go to the Third-party sources section and select Zendesk.

  5. Enter your Zendesk authentication information and click Continue.

  6. Select which entities to sync and click Continue.

  7. Select a region for your data store.

  8. Enter a name for your data connector.

  9. Select a synchronization frequency.

  10. Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.

  11. To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.

    Depending on the size of your data, ingestion can take several minutes or several hours.

Next steps