OneDrive

If you’re new to Unstructured, read this note first.

Before you can create a source connector, you must first sign in to your Unstructured account:

• If you do not already have an Unstructured account, go to https://unstructured.io/contact and fill out the online form to indicate your interest.
• If you already have an Unstructured account, sign in by using the URL of the sign in page that Unstructured provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at [e-mail].

After you sign in, the Unstructured user interface (UI) appears, which you use to get your Unstructured API key. To learn how, watch this 40-second how-to video.

After you create the source connector, add it along with a destination connector to a workflow. Then run the worklow as a job. To learn how, try out the hands-on Workflow Endpoint quickstart, go directly to the quickstart notebook, or watch the two 4-minute video tutorials for the Unstructured Python SDK.

You can also create source connectors with the Unstructured user interface (UI). Learn how.

If you need help, reach out to the community on Slack, or contact us directly.

You are now ready to start creating a source connector! Keep reading to learn how.

Ingest your files into Unstructured from OneDrive.

The requirements are as follows.

• A OneDrive for business plan, or a Microsoft 365 or Office 365 Business or enterprise plan that includes OneDrive. Learn more. Shop for business plans. Shop for enterprise plans. OneDrive personal accounts, and Microsoft 365 Free, Basic, Personal, and Family plans are not supported.

• A SharePoint Online plan, or a Microsoft 365 or Office 365 Business or enterprise plan that includes SharePoint Online. (Even if you only plan to use OneDrive, you still need a plan that includes SharePoint Online, because OneDrive is built on SharePoint technology.) Learn more. Shop for business plans. Shop for enterprise plans.

• The OneDrive and SharePoint Online plans must share the same Microsoft Entra ID tenant. Learn more.

• The path to the target OneDrive folder, starting from the OneDrive account’s root folder, for example my-folder/my-subfolder.

  The following video shows how to get a path:

• Two types of authentication are supported: client credentials and a username and password. Both authentication types require a Microsoft Entra ID app registration. You will need to provide the Application (client) ID, Directory (tenant) ID, and Client secret for the Entra ID app registration that has access to the target OneDrive account, and the app registration must have the correct set of Microsoft Graph access permissions. These permissions include:

  • 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

  1. Create an Entra ID app registration.
  2. Add Graph access permissions to an app registration.
  3. Grant consent for the added Graph permissions.

  The following video shows how to create an Entra ID app registration:

  The following video shows how to add the correct set of Graph access permissions to the Entra ID app registration:

• Both authentication types also require the User Principal Name (UPN) for the OneDrive account. This is typically the OneDrive account user’s email address. To find a UPN:

  1. Depending on your plan, sign in to your Microsoft 365 admin center (typically https://admin.microsoft.com) using your administrator credentials, or sign in to your Office 365 portal (typically https://portal.office.com) using your credentials.
  2. In the Users section, click Active users.
  3. Locate the user account in the list of active users.
  4. The UPN is displayed in the Username column.

  The following video shows how to get a UPN:

• For username and password authentication, you will also need the password for the target UPN.

To create a OneDrive source connector, see the following examples.

Python SDK

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import (
    CreateSourceConnector,
    SourceConnectorType,
    OneDriveSourceConnectorConfigInput
)

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type=SourceConnectorType.ONEDRIVE,
                config=OneDriveSourceConnectorConfigInput(
                    client_id="<client-id>", 
                    user_pname="<user-pname>",
                    password="<password>", # For username and password authentication.
                    tenant="<tenant>", 
                    authority_url="<authority-url>",
                    client_cred="<client-cred>",
                    path="<path>",
                    recursive=<True|False>
                )
            )
        )
    )

    print(response.source_connector_information)

Replace the preceding placeholders as follows:

• <name> (required) - A unique name for this connector.
• <client-id> (required) - The application (client) ID of the Microsoft Entra ID app registration that has access to the OneDrive account.
• <user-pname> (required) - The User Principal Name (UPN) for the OneDrive user account in Entra ID. This is typically the user’s email address.
• <password> (required for username and password authentication): The password for the target UPN.
• <tenant> (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.
• <client-cred> (required) - The client secret for the Entra ID app registration.
• <path> (source connector only) - The path to the target folder in the OneDrive account, starting with the account’s root folder, for example my-folder/my-subfolder.
• For recursive (source connector only), set to true to recursively access files from subfolders within the specified OneDrive <path>. The default is false if not otherwise specified.
• <remote-url> (destination connector only) - onedrive://, followed by the path to the target folder in the OneDrive account, starting with the account’s root folder, for example onedrive://my-folder/my-subfolder.