OneDrive

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

​

Requirements

• 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.
  The OneDrive connector does not support any other authentication methods, such as multifactor (MFA) or passwordless authentication.
  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.

​

Examples

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

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="onedrive",
                config={
                    "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)

​

Configuration settings