> ## 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.
# Microsoft OneDrive
> Learn how to Ingest your files into Unstructured from Microsoft OneDrive.
First time creating a connector? [Read this first](/api-reference/workflow/connector-first-time-reqs).
## Requirements
You will need:
### Account
* A OneDrive for business plan, or a Microsoft 365 or Office 365 Business or enterprise plan that includes OneDrive.
[Learn more](https://www.microsoft.com/microsoft-365/onedrive/compare-onedrive-plans).
[Shop for business plans](https://www.microsoft.com/microsoft-365/business/compare-all-microsoft-365-business-products).
[Shop for enterprise plans](https://www.microsoft.com/microsoft-365/enterprise/microsoft365-plans-and-pricing).
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](https://www.microsoft.com/microsoft-365/SharePoint/compare-SharePoint-plans).
[Shop for business plans](https://www.microsoft.com/microsoft-365/business/compare-all-microsoft-365-business-products).
[Shop for enterprise plans](https://www.microsoft.com/microsoft-365/enterprise/microsoft365-plans-and-pricing).
* The OneDrive and SharePoint Online plans must share the same Microsoft Entra ID tenant.
[Learn more](https://learn.microsoft.com/microsoft-365/enterprise/subscriptions-licenses-accounts-and-tenants-for-microsoft-cloud-offerings?view=o365-worldwide).
### Resources
* 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:
### Authentication and permissions
* 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](https://learn.microsoft.com/entra/identity-platform/quickstart-register-app?pivots=portal).
2. [Add Graph access permissions to an app registration](https://learn.microsoft.com/entra/identity-platform/howto-update-permissions?pivots=portal#add-permissions-to-an-application).
3. [Grant consent for the added Graph permissions](https://learn.microsoft.com/entra/identity-platform/howto-update-permissions?pivots=portal#grant-consent-for-the-added-permissions-for-the-enterprise-application).
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](https://admin.microsoft.com)) using your administrator credentials,
or sign in to your Office 365 portal (typically [https://portal.office.com](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.
## Document permissions metadata
The source connector outputs any permissions information that it can find in the source location about the processed source documents and associates that information with each
corresponding element that is generated. This permissions information is output into the `permissions_data` field, which is within the
`data_source` field under the element's `metadata` field. This information lists the users or groups, if any, that have
permissions to read, update, or delete the element's associated source document.
The permissions metadata Unstructured outputs should not be used for runtime authorization
or access control enforcement.
Unstructured outputs document permissions metadata that is accurate only
at the point in time when Unstructured ingested the corresponding document
to which those permissions applied. Because this metadata is a
point-in-time copy of the permissions in the source location, these
metadata outputs that are sent to your destination location are not
always guaranteed to match the current permissions in the source location.
Also, be aware that Unstructured updates permission metadata for a document only when the document's content has changed.
This is because Unstructured performs incremental processing of documents only when documents' *content* has changed—not when only the documents'
*permissions* have changed. Whenever Unstructured performs incremental processing of documents for a
workflow (in other words, if **Reprocess All Files** is turned off or set
to false for a workflow), that worfklow will not output metadata for any
document permissions that have been added, changed, or removed since the
previous workflow run, *unless* the corresponding documents' content
has also been changed since the previous workflow run.
The following example shows what the output looks like. Ellipses indicate content that has been omitted from this example for brevity.
```json theme={null}
[
{
"...": "...",
"metadata": {
"...": "...",
"data_source": {
"...": "...",
"permissions_data": [
{
"read": {
"users": [
"aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
],
"groups": [
"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"cccccccc-cccc-cccc-cccc-cccccccccccc"
]
}
},
{
"update": {
"users": [
"dddddddd-dddd-dddd-dddd-dddddddddddd",
"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
],
"groups": [
"ffffffff-ffff-ffff-ffff-ffffffffffff"
]
}
},
{
"delete": {
"users": [
"11111111-1111-1111-1111-111111111111"
],
"groups": [
"22222222-2222-2222-2222-222222222222"
]
}
}
],
"...": "..."
}
}
}
]
```
To look up information about a particular Microsoft Entra ID user, use the user's ID along with the
[GET /users](https://learn.microsoft.com/graph/api/user-get) operation in the Microsoft Graph API.
To look up information about a particular Microsoft Entra ID group, use the group's ID along with the
[GET /groups](https://learn.microsoft.com/graph/api/group-get) operation in the Microsoft Graph API.
## Examples
To create a OneDrive source connector, see the following examples.
For more information on working with source connectors using the Unstructured API, see [Source endpoints](/api-reference/api/source/source-apis).
```python Python SDK theme={null}
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="",
type="onedrive",
config={
"client_id": "",
"user_pname": "",
"password": "", # For username and password authentication.
"tenant": "",
"authority_url": "",
"client_cred": "",
"path": "",
"recursive":
}
)
)
)
print(response.source_connector_information)
```
```bash curl theme={null}
curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/sources" \
--header 'accept: application/json' \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'content-type: application/json' \
--data \
'{
"name": "",
"type": "onedrive",
"config": {
"client_id": "",
"user_pname": "",
"password": "", # For username and password authentication.
"tenant": "",
"authority_url": "",
"client_cred": "",
"path": "",
"recursive":
}
}'
```
## Configuration settings
Replace the preceding placeholders as follows:
A unique name for this connector.
The application (client) ID of the Microsoft Entra ID app registration that has access to the OneDrive account.
The User Principal Name (UPN) for the OneDrive user account in Entra ID. This is typically the user's email address.
Required for username and password authentication. The password for the target UPN.
The directory (tenant) ID of the Entra ID app registration.
The authentication token provider URL for the Entra ID app registration.
The client secret for the Entra ID app registration.
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`.
Source connector only. Set to `true` to recursively access files from subfolders within the specified OneDrive `path`.
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`.
Provides authentication for [Unstructured Foundation](/foundation/overview). Unstructured Foundation enables you to processes your files once, maintain a persistent enrichment index, and gives every AI tool your team uses persistent access to your organization’s knowledge without file uploads.
Not supported for the Unstructured Pipeline API.
Provides authentication for [Unstructured Foundation](/foundation/overview). Unstructured Foundation enables you to processes your files once, maintain a persistent enrichment index, and gives every AI tool your team uses persistent access to your organization’s knowledge without file uploads.
Not supported for the Unstructured Pipeline API.