Skip to content

Commit af6be6d

Browse files
committed
add OneDrive setup docs
1 parent 47052d8 commit af6be6d

1 file changed

Lines changed: 86 additions & 0 deletions

File tree

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: Add OneDrive Account
3+
slug: add-onedrive-account
4+
weight: 4.0
5+
description: How to add a Microsoft OneDrive account to Document
6+
date: 2024-01-01T00:00:00
7+
---
8+
9+
10+
## OneDrive Setup
11+
12+
These steps need to be completed within the Azure portal to register an application and obtain the credentials PlaidCloud needs to access OneDrive.
13+
14+
### Register an Application in Azure
15+
16+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to **Microsoft Entra ID**.
17+
2. In the left sidebar, select **App registrations**.
18+
3. Click **+ New registration**.
19+
4. Enter a name for the application (e.g., `PlaidCloud`).
20+
5. Under **Supported account types**, select the option that matches your organization:
21+
- **Accounts in this organizational directory only** — for a single-tenant setup (most common)
22+
- **Accounts in any organizational directory** — for multi-tenant access
23+
6. Leave the **Redirect URI** blank.
24+
7. Click **Register**.
25+
26+
### Copy the Client ID
27+
28+
After registration, you will land on the application overview page.
29+
30+
1. Copy the **Application (client) ID** — this is your **Client ID**. Save it for the PlaidCloud Document setup below.
31+
32+
### Create a Client Secret
33+
34+
1. In the left sidebar, select **Certificates & secrets** under **Manage**.
35+
2. Click **+ New client secret**.
36+
3. Enter a description (e.g., `PlaidCloud`) and choose an expiration period.
37+
4. Click **Add**.
38+
5. Copy the **Value** of the newly created secret immediately — this is your **Client Secret**. It will not be shown again after you leave this page.
39+
40+
### Grant API Permissions
41+
42+
1. In the left sidebar, select **API permissions** under **Manage**.
43+
2. Click **+ Add a permission**.
44+
3. Select **Microsoft Graph**.
45+
4. Select **Delegated permissions** or **Application permissions** depending on your access model:
46+
- Use **Application permissions** for unattended/service access (most common for PlaidCloud Document)
47+
5. Search for and select the following permissions:
48+
- `Files.Read.All` — to read files and folders
49+
- `Files.ReadWrite.All` — if PlaidCloud Document needs to write files
50+
- `Sites.Read.All` — if accessing SharePoint-backed OneDrive for Business libraries
51+
6. Click **Add permissions**.
52+
7. Click **Grant admin consent for [your organization]** and confirm.
53+
54+
---
55+
56+
### Find the OneDrive Drive Path (Start Path)
57+
58+
The **Start Path** in PlaidCloud Document controls which folder in OneDrive is used as the root for the account. To find the correct path:
59+
60+
1. Open [OneDrive](https://onedrive.live.com) or your organization's SharePoint-based OneDrive for Business in a browser.
61+
2. Navigate to the folder you want to use as the root for this PlaidCloud Document account.
62+
3. The path shown in the browser's address bar or the folder breadcrumb reflects the folder hierarchy within OneDrive.
63+
4. Use the relative path from the root of the drive as the **Start Path** — for example, `/Documents/Finance` or `/Shared/Data`.
64+
65+
{{< note >}}
66+
To use the entire OneDrive as the root, leave the Start Path blank. To restrict PlaidCloud Document to a specific folder and its contents, enter the path to that folder.
67+
{{< /note >}}
68+
69+
---
70+
71+
You should now have everything you need to add your OneDrive account to PlaidCloud Document.
72+
73+
74+
## PlaidCloud Document Setup
75+
76+
1. Sign into PlaidCloud
77+
2. Select the workspace that the new Document account will reside
78+
3. Go to `Document > Manage Accounts`
79+
4. Select the `+ New Account` button
80+
5. Select `OneDrive` as the Service Type
81+
6. Fill in a name and description
82+
7. Enter the folder path identified above into the **Start Path** field, or leave it blank to use the root of the drive
83+
8. Select an appropriate **Security Model** for your use case. Leave it `Private` if unsure.
84+
9. Paste the **Client ID** copied from the Azure app registration into the Public Key/User text field under Auth Credentials
85+
10. Paste the **Client Secret** copied from the Azure app registration into the Private Key/Password text field under Auth Credentials
86+
11. Select the Save button and your new Document account is live

0 commit comments

Comments
 (0)