Connect Microsoft SharePoint Online with data federation

This page describes how to connect Microsoft SharePoint Online to Agentspace using data federation.

Use the following procedure to search through your SharePoint account using federated search.

About data federation

With data federation, Agentspace directly retrieves information from the third-party data sources using APIs, instead of copying the data into Agentspace. Using this approach, you can access external data sources immediately, without waiting for ingestion.

Before you begin

Before you can create the connector in Agentspace, you must set up an Entra application registration to enable secure access to SharePoint.

  1. Register Agentspace as an OAuth 2.0 application in Entra.

    1. Navigate to Microsoft Entra admin center.
    2. In the menu, expand the Applications section and select App registrations.
    3. On the App registrations page, select New registration.
      Register a new app in Entra
      Register a new app in Microsoft Entra admin center
    4. Create an app registration on the Register an application page:
      Register Accounts in the organizational directory only
      Select the account type and enter the redirect URI
    5. In the Supported account types section, select Accounts in the organizational directory only.
    6. In the Redirect URI section, select Web and enter the following URLs as web callback URLs (or redirect URLs):

      • https://vertexaisearch.cloud.google.com/console/oauth/sharepoint_oauth.html
      • https://vertexaisearch.cloud.google.com/oauth-redirect
    7. Add a client secret:

      1. Go to Certificates & secrets and click New client secret.
      2. Copy and note the secret string.
  2. Collect the following credentials:

    • Client ID
    • Client secret
    • Instance URL
    • Tenant ID
  3. Configure these SharePoint API (Application) permissions with administrator consent:

    Permission Type
    AllSites.Read Delegated
    MyFiles.Read Delegated
    Sites.Search.All Delegated
  4. Use a dedicated user account with limited access to specific sites.

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

Create a federated search connector with SharePoint

Console

Use the following steps for Google Cloud console to perform federated search through SharePoint from Agentspace.

  1. In the Google Cloud console, go to the Agentspace page.

    Agentspace

  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 SharePoint Federated to connect your third-party source.

    create-data-store
    Search for SharePoint Federated

  5. Under Authentication settings:

    1. Enter the Client ID, Client secret, Instance URL, and Tenant ID.
    2. Click Authenticate.
    3. Click Continue.

      enter-auth-info
      Enter the authentication information

  6. Select the entity types you want to search.

    select-region-enter-name
    Select the entity types

  7. Select a region for your data source.

  8. Enter a name for your data source.

    select-region-enter-name
    Configure your data connector

  9. Click Create. Agentspace creates your data store and displays your data stores on the Data Stores page.

Once the data store is created, go to the Data Stores page and click your data store name to see the status. If the Connector state changes from Creating to Active, the federated search connector is ready to be used.

User authorization

After creating a federated search data store, you can see it listed as one of the data sources in your source management panel. If you haven't previously authorized Agentspace, then you can't select the data source. Instead, an Authorize button appears next to it.

To initiate the authorization flow:

  1. Click Authorize. You are redirected to the SharePoint authorization server.
    click-authorize
    Click Authorize
  2. Sign in to your account.

  3. Click Grant access. After granting access, you are redirected back to Agentspace to complete the authorization flow. Agentspace obtains the access_token, and uses it to access the 3P search.

Query execution

When you enter a search query:

  • If SharePoint is authorized, Agentspace sends the query to the SharePoint API.
  • Agentspace blends the results with those from other sources and displays them.

Data handling

When using third-party federated search, your query string is sent to the third-party search backend. These third parties may associate queries with your identity. If multiple federated search data sources are enabled, the query may be sent to all of them.

Once the data reaches the third-party system, it is governed by that system's Terms of Service and privacy policies (not by Google Cloud's terms).