OneDrive

​

Setup Guide

You can find your OneDrive application credentials by visiting your Microsoft Azure Portal.

You’ll need the following information to set up your OneDrive app with Paragon Connect:

• Client ID
• Client Secret
• Scopes Requested

​

Prerequisites

• A Microsoft Azure account

​

Add the Redirect URL to your OneDrive app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your OneDrive app:

1. Copy the link under “Redirect URL” in your integration settings in Paragon. The Redirect URL is:

https://passport.useparagon.com/oauth

2. Log in to the Microsoft Azure Portal using your Microsoft account.

3. Navigate to All Services > App Registrations and select your application.

4. Select Authentication from the sidebar.

5. Under Platform configurations, press the “Add a platform” button.

6. Select the Web platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the Save button at the top of the page.

​

Generate a Client Secret

Since OneDrive does not automatically provide you with a Client Secret for your application, we’ll need to make one. To get your Client Secret:

1. Navigate to Manage > Certificates & secrets in the sidebar.

2. Under Client Secrets, press the + New client secret button.

3. Name your client credentials and select an expiry that works best for your application. Press Add to create your credentials.

4. Copy the displayed Client Secret under the Value column.

​

Enable Multi-tenancy to your OneDrive app

To allow Microsoft users from outside of your organization to connect to your OneDrive application, you must specify this as an option within the OneDrive application registration.

1. Log in to the Microsoft Azure Portal using your Microsoft account.

2. Navigate to All Services > App Registrations and select your application.

3. Select Authentication from the sidebar.

4. Under Supported account types, press the “Accounts in any organizational directory” option.

5. Click Save.

​

Add your OneDrive app to Paragon

1. Select OneDrive from the Integrations Catalog.

2. Under Integrations > Connected Integrations > OneDrive > Settings, fill out your credentials from the end of Step 1 in their respective sections:

• Client ID: Found under Essentials > Application (client) ID on your Microsoft Azure Portal app page.

• Client Secret: Found under Manage > Certificates & secrets on your Microsoft Azure Portal app page.

• Permissions: Select the scopes you’ve requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. View dashboard.

Press the purple “Save Changes” button to save your credentials.

​

Connecting to OneDrive

Once your users have connected their OneDrive account, you can use the Paragon SDK to access the OneDrive API on behalf of connected users.

See the OneDrive REST API documentation for their full API reference.

Any OneDrive API endpoints can be accessed with the Paragon SDK as shown in this example:

// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// List files in the root of the drive
await paragon.request("onedrive", "/me/drive/root/children", {
  method: "GET"
});


// Download a specific file in a drive
await paragon.request("onedrive", "/me/drive/items/<item-id>/content", {
  method: "GET"
})

​

Building OneDrive workflows

Once your OneDrive account is connected, you can add steps to perform the following actions:

• Save File
• Get File
• List Files
• Create Folder
• Get Folder by ID
• Search Folders
• Move Folder
• Delete Folder

You can also use the OneDrive Request step to access any of OneDrive API endpoints without the authentication piece.

When creating or updating records in OneDrive, you can reference data from previous steps by typing {{ to invoke the variable menu.

​

Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users’ OneDrive account. For example, you might want to trigger a workflow whenever files are changed in OneDrive to sync your users’ OneDrive files to your application in real-time.

You can find the full list of Webhook Triggers for OneDrive below:

• File Change

​

Using the OneDrive File Picker

You can allow your user to select files from their OneDrive account in your app with the Paragon SDK.

Showing the File Picker

Use the Paragon SDK in your frontend application to show the File Picker in your app.

The SDK provides an ExternalFilePicker class to load OneDrive’s JavaScript into your page and authenticate with your user’s connected OneDrive account.

let picker = new paragon.ExternalFilePicker("onedrive", {
    onFileSelect: (files) => {
        // Handle file selection
    }
});

// Loads external dependencies and user's access token
await picker.init();

// Open the File Picker
picker.open();

You can configure the File Picker to listen for additional callbacks or to restrict allowed file types. Learn more about configuring File Picker options in the SDK Reference.

​

Downloading the Selected File

The OneDrive File Picker callback will return a Response object describing the user’s file picker interaction including an array of any files selected. Using this array of fileIds, you can use the Proxy API to perform an authenticated proxy requests to download the files.

await paragon.request('onedrive', '/me/drive/items/<fileId>/content', {
	method: 'GET'
});