Platform: OneDrive source connector (#333)

Author: Paul-Cornell

mint.json

@@ -451,6 +451,7 @@
                 "platform/sources/azure-blob-storage",
                 "platform/sources/databricks-volumes",
                 "platform/sources/google-cloud",
+                "platform/sources/onedrive",
                 "platform/sources/s3",
                 "platform/sources/sharepoint"
               ]

platform/connectors.mdx

@@ -13,6 +13,7 @@ The Unstructured Platform supports connecting to the following source and destin
 
 - [Azure](/platform/sources/azure-blob-storage)
 - [Google Cloud Storage](/platform/sources/google-cloud)
+- [OneDrive](/platform/sources/onedrive)
 - [S3](/platform/sources/s3)
 - [SharePoint](/platform/sources/sharepoint)
 

platform/sources/onedrive-cloud-storage.mdx renamed to platform/sources/onedrive.mdx

@@ -20,6 +20,7 @@ To create a source connector:
 
    - [Azure](/platform/sources/azure-blob-storage)
    - [Google Cloud Storage](/platform/sources/google-cloud)
+   - [OneDrive](/platform/sources/onedrive)
    - [S3](/platform/sources/s3)
    - [SharePoint](/platform/source/sharepoint)
 

platform/sources/overview.mdx

@@ -10,10 +10,10 @@ import AdditionalIngestDependencies from '/snippets/general-shared-text/ingest-d
 
 The following environment variables:
 
-- `ONEDRIVE_PATH` - The path to the target OneDrive folder, represented by `--path` (CLI) or `path` (Python).
-- `ONEDRIVE_CLIENT_ID` - The client ID for the Azure app that is registered with Microsoft Graph and assigned the correct OneDrive authentication scopes in Microsoft Entra ID (formerly Azure Active Directory (Azure AD)), represented by `--client-id` (CLI) or `client_id` (Python).
-- `ONEDRIVE_CLIENT_CRED` - The client secret for the Azure app, represented by `--client-cred` (CLI) or `client_cred` (Python).
-- `ONEDRIVE_TENANT` - The tenant for the Azure app, represented by `--tenant` (CLI) or `tenant` (Python).
-- `ONEDRIVE_USER_PNAME` - The Entra ID principal name (typically your Entra ID email), represented by `--user-pname` (CLI) or `user_pname` (Python).
-- `ONEDRIVE_AUTHORITY_URL` - The authentication token provider for Microsoft apps (typically `https://login.microsoftonline.com`, the default if not otherwise specified), represented by `--authority-url` (CLI) or `authority_url` (Python).
+- `ONEDRIVE_PATH` - The path to the target folder in the OneDrive account, starting with the account's root folder (for example `my-folder/my-subfolder`), represented by `--path` (CLI) or `path` (Python).
+- `ONEDRIVE_CLIENT_ID` - The application (client) ID of the Microsoft Entra ID app registration that has access to the OneDrive account, represented by `--client-id` (CLI) or `client_id` (Python).
+- `ONEDRIVE_CLIENT_CRED` - The client secret for the Entra ID app registration, represented by `--client-cred` (CLI) or `client_cred` (Python).
+- `ONEDRIVE_TENANT` - The directory (tenant) ID of the Entra ID app registration, represented by `--tenant` (CLI) or `tenant` (Python).
+- `ONEDRIVE_USER_PNAME` - The User Principal Name (UPN) for the OneDrive user account in Entra ID (typically the user's email address), represented by `--user-pname` (CLI) or `user_pname` (Python).
+- `ONEDRIVE_AUTHORITY_URL` - The authentication token provider URL for the Entra ID app registration (the default is `https://login.microsoftonline.com` if not otherwise specified), represented by `--authority-url` (CLI) or `authority_url` (Python).
 

snippets/general-shared-text/onedrive-cli-api.mdx

@@ -1,10 +1,13 @@
 Fill in the following fields:
 
 - **Name** (_required_): A unique name for this connector.
-- **Client ID** (_required_): The ID of the client for the associated Microsoft Entra ID app.
-- **Client Credential** (_required_): The credential for the associated Entra ID app.
-- **Tenant ID** (_required_): The ID of the tenant for the associated Entra ID app.
-- **Authority URL**: The URL for the authentication token provider for Entra ID app (typically **https://login.microsoftonline.com**).
-- **Principal Name** (_required_): The name of the Entra ID principal (typically your Entra ID email).
-- **Path**: Path to the target OneDrive folder.
-- **Recursive**: Check this box recursively access files from subfolders within the specified OneDrive path.
+- **Client ID** (_required_): The application (client) ID of the Microsoft Entra ID app registration that has access to the OneDrive account.
+- **Tenant ID** (_required_): The directory (tenant) ID of the Entra ID app registration.
+- **Authority URL** (_required_): The authentication token provider URL for the Entra ID app registration. The default is `https://login.microsoftonline.com`.
+- **Principal Name** (_required_): The User Principal Name (UPN) for the OneDrive user account in Entra ID. This is typically the user's email address.
+- **Path**: The path to the target folder in the OneDrive account, starting with the account's root folder, for example `my-folder/my-subfolder`.
+- **Recursive**: Check this box to recursively access files from subfolders within the specified OneDrive path.
+- **Client Credential** (_required_): The client secret for the Entra ID app registration.
+
+
+

snippets/general-shared-text/onedrive-platform.mdx

@@ -1,29 +1,28 @@
 The OneDrive prerequisites:
 
-- A OneDrive account.
-- Path to the target OneDrive folder.
-- The client ID, client secret, and tenant ID for the Azure app that is registered with Microsoft Graph and assigned the correct OneDrive authentication scopes in Microsoft Entra ID (formerly Azure Active Directory (Azure AD)). See [Registering your app for Microsoft Graph](https://learn.microsoft.com/onedrive/developer/rest-api/getting-started/app-registration) and [OneDrive authentication and sign-in](https://learn.microsoft.com/onedrive/developer/rest-api/getting-started/msa-oauth).
-
-  <iframe
-  width="560"
-  height="315"
-  src="https://www.youtube.com/embed/uJsdMIpuuno?start=14&end=372"
-  title="YouTube video player"
-  frameborder="0"
-  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
-  allowfullscreen
-  ></iframe>
+<iframe
+width="560"
+height="315"
+src="https://www.youtube.com/embed/7uSu0LsbcEQ"
+title="YouTube video player"
+frameborder="0"
+allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
+allowfullscreen
+></iframe>
 
-  <iframe
-  width="560"
-  height="315"
-  src="https://www.youtube.com/embed/aKNmym2nYzY?start=43&end=241"
-  title="YouTube video player"
-  frameborder="0"
-  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
-  allowfullscreen
-  ></iframe>
+- A OneDrive account.
+- The User Principal Name (UPN) for the OneDrive account. This is typically the OneDrive account user's email address.
+- The path to the target OneDrive folder, starting from the OneDrive account's root folder, for example `my-folder/my-subfolder`.
+- The client ID, tenant ID, and client secret for the Microsoft Entra ID app registration that has access to the target OneDrive account and 
+  also has the correct set of Microsoft Graph authentication scopes. These scopes include:
 
-- The Entra ID principal name (typically your Entra ID email).
+  - `Files.ReadWrite.All` (if both reading and writing are needed)
+  - `Sites.ReadWrite.All` (if both reading and writing are needed)
+  - `User.Read.All`
+  - `Directory.Read.All`
+  
+See also:
 
-See also the [OneDrive API documentation](https://docs.microsoft.com/onedrive/developer/rest-api/).
+- [Registering your app for Microsoft Graph](https://learn.microsoft.com/onedrive/developer/rest-api/getting-started/app-registration)
+- [OneDrive authentication and sign-in](https://learn.microsoft.com/onedrive/developer/rest-api/getting-started/msa-oauth)
+- [OneDrive API documentation](https://docs.microsoft.com/onedrive/developer/rest-api/)