Microsoft OneDrive Business Connector

Intro

Microsoft OneDrive for Business is an online file sharing and personal cloud content management service for businesses. For more information about the OneDrive API, see https://msdn.microsoft.com/en-us/lib…/dn659752.aspx. You connect to your OneDrive for Business account in the Data Center. This topic discusses the fields and menus that are specific to the OneDrive for Business connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Connector.

Prerequisites

To connect to your OneDrive for Business account and create a DataSet, you must have the following:

A OneDrive for Business client secret
A Microsoft username and password

If you are using the Microsoft Graph, you will need to set your redirect_uri to a different URL depending on whether you are using a newly registered or existing app.

If you are using a newly registered app, set your redirect_uri to https://oauth.domo.com/api/data/v1/oauth/providers/onedrive-business/exchange.
If you are using an existing app, set your redirect_uri to https://oauth.domo.com/api/data/v1/oauth/providers/microsoft-onedrive-business/exchange.

For instructions about obtaining a OneDrive for Business client ID, client secret, and registering your app using SharePoint Server 2016, see https://dev.onedrive.com/app-registration-server.htm. For instructions about registering your app for Microsoft Graph, see https://docs.microsoft.com/en-us/onedrive/app-registration.htm To connect to Microsoft OneDrive for Business to retrieve the information, you must have the following:

An installed Microsoft Azure app.
The CLIENT ID and CLIENT SECRET. To generate an app and locate these credentials, see Microsoft’s documentation. You may need the following information to register for the app:
- Azure Portal: https://portal.azure.com/
- Sharepoint App to Register: SharePoint Online Rest API
- Domo Re-direct URL: https://oauth.domo.com/api/data/v1/oauth/providers/microsoft-onedrive-business/exchange
The Microsoft OneDrive for Business Connector needs the following API permissions.
- User.Read
- Files.Read.All
- offline_access

Setting Up the Azure Portal Video

To set up the Azure portal, watch the YouTube video, How to Set Up the OneDrive for Business Connector.

To Obtain the OneDrive CLIENT ID:

Go to https://portal.azure.com.
Select Microsoft Entra ID (https://learn.microsoft.com/en-us/entra/fundamentals/new-name)> App registrations.
Find and click on your web app.
The “application” ID is your CLIENT ID.

To obtain the OneDrive CLIENT SECRET:

Go to https://portal.azure.com.
Select Microsoft Entra ID (https://learn.microsoft.com/en-us/entra/fundamentals/new-name)> App registrations.
Find and click on your web app.
Open Certificates and secrets.
Click +New Value.
Provide the value description and the expiry period for your secret. Click Add.
Your new value will appear. Copy the Value field and paste it in your Domo connector Value field.

Creating an Azure App for Enterprise OAuth

To create a Microsoft Azure app, do the following:

Log into https://portal.azure.com.
Click on App registrations. 3. Click New registration.
Enter the application name and select the supported account type. Enter the Redirect URI for Web as https://oauth.domo.com/api/data/v1/oauth/providers/microsoft-onedrive-business/exchange.
Click Register.
Now, click API Permissions. 7. Click +Add Permissions button.
Select the permissions as required.
After adding the permissions, all configured permissions will be listed as below.

Connecting to Your OneDrive for Business Account

This section enumerates the Permission settings within Microsoft needed for Domo access as well as options in the Credentials and Details panes in the OneDrive for Business Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to your OneDrive for Business account. The following table describes what is needed for each field:

Field	Description
Client ID	Enter your OneDrive for Business client ID.
Client Secret	Enter your OneDrive for Business client secret.

Once you have entered these credentials, you are taken to the Microsoft login screen, where you can enter the username and password for your Microsoft account. After you successfully connect, you can use the same account any time you go to create a new OneDrive for Business DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Details Pane

This pane contains a primary Report menu, along with various other menus which may or may not appear depending on the report type you select.

Report

Select the OneDrive for Business report you want to run. The following reports are available:

Report Name	Description
Download Shared File (Using SharingURL)	Downloads a shared file into Domo as a DataSet. You specify the file type, file or folder path, and other information.
Children	Lists the children of the item with the specified folder or path.
Default Drive	Returns metadata about the authenticated user’s default drive in OneDrive.
Download File	Downloads a file into Domo as a DataSet. You specify the file type, file or folder path, and other information.
Drive By Id	Lists drives for a selected drive ID.
Drives	Lists the available drives for the authenticated user.
Properties	Returns properties for the item with the specified file/folder or path.
Recent Items	Returns a list of items that have been recently used by the authenticated user. This list includes items that are in the user’s drive as well as items they have access to from other drives.
Shared Items — DEPRECATED	Lists items that are shared with the authenticated user.
Download Nested Children Shared File — DEPRECATED	Downloads a shared file from a nested children folder into Domo as a DataSet. You specify the folder name and the complete file path, along with other information.
Download Shared File (Search Endpoint) — DEPRECATED	Downloads a shared file into Domo as a DataSet. You specify the file type, file or folder path, and other information.
Download Shared File (SharedWithMe Endpoint) — DEPRECATED	Downloads a shared file into Domo as a DataSet. You specify the file type and file/folder or path, along with other information.
Download Children Shared File — DEPRECATED	Downloads a shared file from the children folder into Domo as a DataSet. You specify the file type, file or folder path, and other information.

Deprecated reports: Use the Download Shared File (Using SharingURL) report instead of any of the deprecated reports listed above.

Other Menus

The following menus may also appear depending on the report you select:

Menu	Description
Addressing	Specify whether the addressing for the item is ID-based (in which case, you specify a file or folder name) or path-based (in which case, you specify the file path).
Path	Enter the relative path of the file or folder you want to retrieve a report for. For example: `/Documents/test.csv`
File/Folder Name	Enter the name (or a portion of the name), without extension, of the MS OneDrive file/folder to retrieve. The connector returns the most recently created or modified file matching the name, based on what you have selected in the Date Field menu.
Match Type	Specify whether the retrieve file starts with or contains the name you have entered in File Name.
Parent Folder/Parent Folder Name	Enter a complete folder name (not case-sensitive) to limit the file search to a specific folder’s root contents. Subfolders are ignored. If you leave this blank, the search includes all files in all folders for which you have access.
Date Field	Specify whether to retrieve a file based on its creation or last modified date. This is useful when there are multiple files containing the name you have entered in File Name.
File Type	Select the file type for the data file you want to retrieve.
Is Password Protected?	Select whether the file is password-protected.
Sheet Name	Enter the sheet name you want to retrieve in the specified spreadsheet.
Sheet Name Match Type	Select the match type you want to perform on the sheet name.
File Name or Portion of File Name to Search For in ZIP	Enter the name of the zipped file to retrieve. Leave blank to retrieve the first zipped file.
Zipped File Type	Select the file type for the zipped data file you want to retrieve.
Drive ID	Select the drive you want to retrieve information for.

FAQ

Which report can I use to download a file that has been shared with me?

You can use the Download Shared File (Using SharingURL) report to access shared files. This report supports the following file formats: CSV, XLS, XLSX, XML, ZIP, and GZIP.

I have a dataset that uses one of the deprecated reports to get a shared file. Do I need to recreate my dataset?

Dataset recreation isnot required. You can change the report the connector is using in the connector details to Download Shared File (Using SharingURL) report and enter the URL of the target file. The dataset settings and schema will remain unchanged.

What kind of credentials do I need to power up this connector?

You need the client ID and client secret of your OneDrive App.

How often can the data be updated?

Datasets should be set to update no more than once per hour.

Are there any API limits that I need to be aware of?

Microsoft limits API calls on a per-user/per-app basis. To prevent rate limiting, reduce the number of datasets scheduled to run at the same time.

Getting Started

Domo Free

Connect & Integrate

Transform & Manage

Visualize & Interact

AI & Data Science

Automate

Distribute

Admin

General Information

Microsoft OneDrive Business Connector

Intro

Prerequisites