Connect Microsoft OneDrive

This page describes how to connect Microsoft OneDrive to Agentspace. The connector supports both data ingestion and federated search. See the section for the approach you plan to use:

• Connect OneDrive Online and ingest data

• Use Federated Search with OneDrive (Preview)

Connect OneDrive Online and ingest data

Use the following procedure to sync data from OneDrive.

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.

Limitations

Incremental sync does not detect folder-level actions like Copy, Move, or Rename.

Before you begin

To enforce data source access control and secure data in Agentspace, ensure that you have configured your identity provider.

About Microsoft Entra ID application registration

Before you can create the connector in Agentspace, you must set up a Microsoft Entra ID application registration to enable secure access to OneDrive. How you register the application depends on the authentication method that you select when you're creating the connector in Agentspace. You can choose one of the following methods:

• Federated credentials:

  • Allows Google to securely access OneDrive using cryptographically signed tokens, avoiding the need for a real user principal.

  • Requires a subject ID to register Agentspace in Entra. This is available when you create the OneDrive connector in Agentspace.

  • When you register your app in Entra ID, you must gather the following details:

    • Instance URI:
      • For all first-level sites: https://DOMAIN_OR_SERVER.onedrive.com —for example, mydomain.onedrive.com.
      • For a single site: https://DOMAIN_OR_SERVER.onedrive.com/[sites/]WEBSITE —for example, mydomain.onedrive.com/sites/sample-site.
    • Tenant ID
    • Client ID

    These details are necessary to complete the authentication and create the OneDrive connector in Agentspace.

  • Google recommends that you use this method.

• OAuth 2.0 refresh token:

  • Gives a granular control over who connects to the OneDrive API.

  • When you register your app in Entra ID, you must gather the following details:

    • Instance URI: This is in the following form:
      • For all first-level sites: https://DOMAIN_OR_SERVER.onedrive.com —for example, mydomain.onedrive.com.
      • For a single site: https://DOMAIN_OR_SERVER.onedrive.com/[sites/]WEBSITE —for example, mydomain.onedrive.com/sites/sample-site.
    • Tenant ID
    • Client ID
    • Client secret

    These details are necessary to complete the authentication and create the OneDrive data store in Agentspace.

  • The authentication process includes signing in to your OneDrive account.

  • This method is suitable when your OneDrive set up requires a two-factor authentication.

  • Requires you to create a new OneDrive user, which might add licensing costs.

• OAuth 2.0 password grant:

  • Gives granular control over who connects to the OneDrive API.

  • When you register your app in Entra ID, you must gather the following details:

    • Instance URI:
      • For all first-level sites: https://DOMAIN_OR_SERVER.onedrive.com —for example, mydomain.onedrive.com.
      • For a single site: https://DOMAIN_OR_SERVER.onedrive.com/[sites/]WEBSITE —for example, mydomain.onedrive.com/sites/sample-site.
    • Tenant ID
    • Client ID
    • Client secret

    These details are necessary to complete the authentication and create the OneDrive data store in Agentspace.

  • The authentication process includes providing your Entra ID admin-provided username and password.

  • This method is suitable when your OneDrive setup doesn't require a two-factor authentication.

  • This method requires you to create a new OneDrive user, which might add licensing costs.

Set up federated credentials

Use the following steps to configure the app registration, grant permissions, and establish authentication. Google recommends that you use the federated credentials method.

Some common error messages that you might encounter during this process are listed in Error messages.

1. Obtain service account client ID:

   1. In the Google Cloud console, go to the Agentspace page.
   2. In the navigation menu, click Data stores.
   3. Click add Create data store.
   4. On the Select a data source page, scroll or search for OneDrive to connect your third-party source.
   5. Note the Subject identifier. Don't click Continue yet. Perform the next steps in this task and then complete the steps in the Google Cloud console by following the instructions in Create a OneDrive connector.

2. Register app in Entra ID:

   1. Navigate to Microsoft Entra administrator center.
   2. In the menu, expand the Applications section and select App registrations.
   3. On the App registrations page, select New registration.

      

   4. Create an app registration on the Register an application page:

      • In the Supported account types section, select Accounts in the organizational directory only.
      • In the Redirect URI section, select Web and enter the redirect URI https://vertexaisearch.cloud.google.com/console/oauth/onedrive_oauth.html
      • Keep the default values for the other settings and click Register.

        

   5. Note the Client ID and Tenant ID.

      

3. Add federated credentials:

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

      

   2. Use the following settings:

      • Federated credential scenario: Other issuer

      • Issuer: https://accounts.google.com

      • Subject identifier: Use the value of Subject identifier that you noted in the previous step.

      • Name: Provide a unique name.

   3. Click Add to grant access.

      

4. Set API permissions.

   

   1. Add and grant the following Microsoft Graph permissions. You can choose between the site control options (Sites.FullControl.All and Sites.Selected) and profile reading options (User.Read.All and User.ReadBasic.All):

      Microsoft Graph permissions for federated credentials

      Permission	Type	Description	Justification
      GroupMember.Read.All	Application	Read all group memberships	This permission allows Agentspace to understand the memberships of the user groups in the OneDrive site.
      User.Read	Delegated	Sign in and read user's profile	This is a default permission that must not be removed. When removed, OneDrive displays an error asking you to reinstate this permission.
      Files.Read.All	Application	Read files in all site collections	This permission allows Agentspace to read all files in all site collections.
      Site control options
      Option 1: Sites.FullControl.All	Application	Full control over all sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across all OneDrive sites. If giving full control over all sites seems excessive, use Option 2: Sites.Selected to give granular control.
      Option 2: Sites.Selected	Application	Control over selected sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across selected OneDrive sites. This permission provides more granular control instead of Sites.FullControl.All
      Profile reading options
      Option 1: User.Read.All	Application	Read all users' full profiles	This permission allows Agentspace to understand the data access control for your OneDrive content.
      Option 2: User.ReadBasic.All	Application	Read all users' basic profiles	This permission allows Agentspace to understand the data access control for your OneDrive content.

   2. Add and grant the following OneDrive permissions. You can choose between Sites.FullControl.All and Sites.Selected:

      OneDrive permissions for federated credentials

      Permission	Type	Description	Justification
      Option 1: Sites.FullControl.All	Application	Full control over all sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across all OneDrive sites. If giving full control over all sites seems excessive, use Option 2: Sites.Selected to give granular control.
      Option 2: Sites.Selected	Application	Control over selected sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across selected OneDrive sites.

   3. For the added permissions, check that the Status column lists the permission as Granted and has a green check icon.

      

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

Set up OAuth 2.0 for refresh token and password grant

You can use the OAuth 2.0 method to set up an Entra ID application registration and enable secure access to OneDrive. This method includes steps to configure the app registration, grant permissions, and establish authentication.

You can use the following process to register the application in Entra ID using OAuth 2.0 authentication for refresh token and for password grant. This method is preferred when you need granular control over OneDrive REST API permissions, allowing you to restrict resource access on the user account.

Some common error messages that you might encounter during this process are listed in Error messages.

The following table describes the OneDrive roles that are recommended for OAuth 2.0 authentication methods:

View roles

Recommended OneDrive roles for OAuth 2.0 authentication methods

Roles	Client application registration	Fetch content of all entities	Fetch ACL	Fetch identity	Notes
Site Admins	No	Yes	Yes	Yes
Site Collection administrator	No	Yes	Yes	Yes
Global administrator	Yes	No	Yes	No	Limitation: The global administrator cannot fetch identity or comment and attachment entities.
Site owner	No	Yes	Yes	No	Limitation: The Site owner relates to Microsoft 365 administrator center / Entra ID administrator center, not specific to OneDrive.
Application administrator	Yes	N/A	N/A	N/A	The application administrator role is related to Microsoft 365 administrator center / Entra ID administrator center. It is not specific to OneDrive.

1. Create app registration:

   1. Navigate to Entra ID administrator center.

   2. Create an app registration:

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

   3. Note the Client ID and Tenant ID.

2. Add client secret:

   1. Go to Certificates & secrets > New client secret.
   2. Note the secret string.

3. Set API permissions.

   1. Add and grant the following Microsoft Graph permissions. You can choose between Sites.FullControl.All and Sites.Selected:

      Microsoft Graph permissions for OAuth 2.0 authentication

      Permission	Type	Description	Justification
      GroupMember.Read.All	Application	Read all group memberships	This permission allows Agentspace to understand the memberships of the user groups in the OneDrive site.
      User.Read	Delegated	Sign in and read user's profile	This is a default permission that must not be removed. When removed, OneDrive displays an error asking you to reinstate this permission.
      Option 1: Sites.FullControl.All	Application	Full control over all sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across all OneDrive sites.
      Option 2: Sites.Selected	Application	Control over selected sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across selected OneDrive sites. This permission provides more granular control instead of Sites.FullControl.All
      User.Read.All	Application	Read all users' full profiles	This permission allows Agentspace to understand the data access control for your OneDrive content.

   2. Add and grant the following OneDrive permissions for OAuth 2.0 authentication. You can choose between AllSites.FullControl and Sites.Selected:

      OneDrive permissions for OAuth 2.0 authentication

      Permission	Type	Description	Justification
      Option 1: AllSites.FullControl	Delegated	Full control over all sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across all OneDrive sites.
      Option 2: Sites.Selected	Delegated	Control over selected sites	This permission allows Agentspace to obtain the OneDrive user groups and role assignments, which aren't included in the Sites.Read.All permission. It also allows Agentspace to index documents, events, comments, attachments, and files across selected OneDrive sites. This permission provides more granular control instead of AllSites.FullControl.

   3. For the added permissions, check that the Status column lists the permission as Granted and has a green check icon.

   4. Use a dedicated user account with limited access to specific sites. Verify that this account has Owner access to the selected sites.

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

Error messages

The following table describes the common error messages and their descriptions that you might encounter when connecting OneDrive with Agentspace.

Error code	Error message
ONEDRIVE_MISSING_PERMISSION_1	Missing required REST API role (Sites.FullControl.All or Sites.Selected). For delegated permissions, missing AllSites.FullControl or Sites.Selected.
ONEDRIVE_MISSING_PERMISSION_2	Missing required Graph API role (Sites.FullControl.All or Sites.Selected).
ONEDRIVE_MISSING_PERMISSION_3	Missing required Graph API role GroupMember.Read.All.
ONEDRIVE_MISSING_PERMISSION_4	Missing required Graph API role (User.Read.All or User.ReadBasic.All).
ONEDRIVE_INVALID_SITE_URI	Failed to retrieve Graph API access token. Possible causes: invalid client ID, secret value, or missing federated credentials.
ONEDRIVE_INVALID_AUTH	Failed to retrieve Graph API access token. Possible causes: invalid client ID, secret value, or missing federated credentials.
ONEDRIVE_INVALID_JSON	Failed to parse JSON content.
ONEDRIVE_TOO_MANY_REQUESTS	Too many HTTP requests sent to OneDrive; received 429 HTTP response.

1. Manifest file:

   1. Go to the Manifest tab.

   2. Delete the contents between [ and ] under requiredResourceAccess.

      

   3. Paste the following JSON between the brackets.

      {
       "resourceAppId": "00000003-0000-0000-c000-000000000000",
       "resourceAccess": [
         {
           "id": "01d4889c-1287-42c6-ac1f-5d1e02578ef6",
           "type": "Role"
         },
         {
           "id": "5b567255-7703-4780-807c-7be8301ae99b",
           "type": "Role"
         },
         {
           "id": "df021288-bdef-4463-88db-98f22de89214",
           "type": "Role"
         }
       ]
      }
      

   4. Return to API permissions.

   5. Confirm all required permissions are present.

   6. Grant administrator consent.

Create a OneDrive connector

Enable real-time sync

To enable real-time sync for your data store, follow these steps.

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

   Agentspace

2. In the navigation menu, click Data stores.

3. Click the name of the OneDrive data store for which you want to enable real-time sync.

4. On the data store Data page, wait until the Connector state changes to Active.

5. In the Real-time sync field, click View/edit.

   

6. Click the Enable real-time sync toggle to the on position.

7. Provide a value for Client secret. This value is used to verify OneDrive webhook events. We recommend using a string of 20 characters.

   

8. Click Save.

   Wait for the Real-time sync field to change to Running.

Error codes

The following table lists OneDrive error codes and descriptions.

Error code	Description
ONEDRIVE_MISSING_PERMISSION_1	The application does not have a required Files.Read.All role for Graph API.
ONEDRIVE_MISSING_PERMISSION_2	The application does not have a required Group.Read.All role for Graph API.
ONEDRIVE_MISSING_PERMISSION_3	The application does not have a required User.Read.All role or User.ReadBasic.All role for Graph API.
ONEDRIVE_INVALID_SITE_URI	The instance URL is invalid.
ONEDRIVE_INVALID_AUTH	Error when retrieving Graph API access token. This may be due to an invalid client id, secret value, or missing federated credentials.
ONEDRIVE_UNCATEGORIZED_ERROR	Invalid or no ACL is present in file.
ONEDRIVE_TOO_MANY_REQUESTS	Too many HTTP requests are sent to OneDrive. Received HTTP 429 response.

Next steps

• To attach your data store to an app, create an app and select your data store following the steps in Create an app.

• To preview how your search results appear after your app and data store are set up, see Preview search results.

Use Federated Search with OneDrive

Use the following procedure to search your Microsoft OneDrive account using federated search.

About federated search

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 the Microsoft OneDrive federated setup

Perform the following steps before connecting to your Microsoft OneDrive data store using federated search.

1. Register Agentspace as an OAuth 2.0 application in Microsoft Entra ID. Copy the following credentials:

   • Client ID
   • Client secret
   • Tenant ID

2. Configure the following Microsoft Graph application permissions with the consent of a Microsoft OneDrive administrator:

   Permission	Type	Description
   Files.Read.All	Delegated	Read all files that user can access
   Sites.Read.All	Delegated	Read items in all site collections

3. Add the following URLs as web callback URLs:

   • https://vertexaisearch.cloud.google.com/console/oauth/default_oauth.html
   • https://vertexaisearch.cloud.google.com/oauth-redirect

Create a federated search connector with OneDrive

Use the following steps for Google Cloud console to perform federated search through Microsoft OneDrive 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, select OneDrive Federated Search to connect your third-party data source.

5. Under Authentication settings, select the authentication method to use.

   1. Enter the Client ID, Client secret, Instance URL, and Tenant ID.

   2. Click Authenticate.

   3. Click Continue.

6. Select a region for your data source.

7. Enter a name for your data source.

8. Click Create. Agentspace creates your data store and displays it 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. When 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 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.

To initiate the authorization flow:

1. Click Authorize. You are redirected to the OneDrive authorization server.

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 Microsoft OneDrive search.

Query execution

After you authorize Microsoft OneDrive, when you enter a search query:

1. Agentspace sends your search query to the Microsoft Graph API.

2. 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 might 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.