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, sign up for free. After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io. To sign up for a Team or Enterprise account instead, contact Unstructured Sales, or learn more.
- If you already have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io. For an Enterprise account, see your Unstructured account administrator for instructions, or email Unstructured Support at support@unstructured.io.
-
After you sign in to your Unstructured Starter account, click API Keys on the sidebar.
For a Team or Enterprise account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more. -
Click Generate API Key.
-
Follow the on-screen instructions to finish generating the key.
-
Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
- 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:The OneDrive connector does not support any other authentication methods, such as multifactor (MFA) or passwordless authentication.
-
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
- Create an Entra ID app registration.
- Add Graph access permissions to an app registration.
- Grant consent for the added Graph permissions.
-
-
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:
- 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.
- In the Users section, click Active users.
- Locate the user account in the list of active users.
- The UPN is displayed in the Username column.
- For username and password authentication, you will also need the password for the target UPN.
<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 examplemy-folder/my-subfolder
.- For
recursive
(source connector only), set totrue
to recursively access files from subfolders within the specified OneDrive<path>
. The default isfalse
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 exampleonedrive://my-folder/my-subfolder
.