Skip to main content

Microsoft OneDrive

The OneDrive connector lets you connect to Microsoft OneDrive cloud storage in Designer. OneDrive is available as a data source in the Input Data and Output Data tools.

Upgrade to the New OneDrive Connector

If your workflow uses the standalone OneDrive Input or OneDrive Output tools, those are now deprecated. Instead, use connector version 2.2.0 or later with the Input Data and Output Data tools. Use the workflow migration utility to update existing workflows.

Requirements

Requirement

Details

Designer

Designer 2026.1 or later.

Designer 2025.2 Patch 3 or later.

Designer 2025.1 Patch 5 or later.

Connector Version

Microsoft OneDrive version 2.2.0 or later. Available from Designer Add-Ons.

Azure Permissions

See Set Up Microsoft Azure API Application.

DCM

You must enable DCM in Designer. Go to Options >Advanced Settings > DCM to enable it.

Network Access

Outbound access to OneDrive Online and Microsoft OAuth endpoints.

Install the Connector

Install the latest version of OneDrive connector directly from Designer using Add-Ons. This is the recommended installation method that allows you to browse, install, and update connectors without leaving Designer or visiting the Alteryx Marketplace.

To install the connector...

  1. In Designer, go to Add-Ons > Manage Marketplace Add-Ons. You will see a list of available connectors.

  2. Select Microsoft OneDrive Connector and select Install. Designer downloads and installs the package. Designer might require a restart to complete the installation.

  3. After installation and setup are complete, the OneDrive connector is available from the Input Data and Output Data tools.

Set Up a Connection

To connect to Microsoft OneDrive...

  1. Drag the Input Data or Output Data tool to the canvas, and select Connect to Data.

  2. In the Connector Setup, select Create or Browse a Data Connection.

    If you've created a Microsoft OneDrive connection before, you can select the connection from the Recents tab.

  3. Select + New. From the list of technologies, select Microsoft OneDrive.

  4. Enter the Connection Name and Data Source Name.

  5. In the Credentials section, select your authentication method, and enter the credentials. For more information, see Authentication Methods.

  6. Select Save. You can also test the connection before saving.

  7. Select Connect. Microsoft OneDrive may request authentication.

  8. Select the read or write configuration in the Options window. To know more about the options, see Read Data from OneDrive or Write Data to OneDrive.

  9. Select Confirm to create a connection to the file. You can continue building your workflow.

Workflow Migration

If your existing workflows use the deprecated OneDrive Input or OneDrive Output tools, you need to migrate them to use the new connector. Use the workflow migration utility to update existing workflows.

The utility previews all the changes and replaces deprecated tool instances with the new connector versions without breaking the workflows.

Authentication Methods

Microsoft OneDrive supports three authentication methods. Use the table below to choose the right one for your use case.

Method

Details

Azure AD-private (Built-In App)

  • Use this to set up a personal, ad hoc connection with your own Microsoft credentials.

  • Email and password are tied to your personal Microsoft credentials.

  • This can be used for SDK.

  • Not recommended for scheduling workflows.

  • DCM is optional.

Azure AD-private (Custom App)

  • Use this when your team shares a custom-registered Azure app.

  • This can be used for SDK.

  • For instructions on the set up, see Microsoft Azure API app setup.

  • DCM is optional.

Service Principal (Application)

  • Use this to schedule or automate workflows without tying authentication to a specific user.

  • Leverages the capabilities of custom API applications with a service principal.

  • For instructions on the setup, see Microsoft Azure API app setup.

  • DCM is required.

Limitations

The Microsoft OneDrive connector currently has the following limitations:

  • Microsoft's underlying Recent and Shared with Me Graph APIs are deprecated and do not return data. This is a platform-level limitation independent of this connector.

  • Partitioning is not supported.

  • Reading data with wildcards or from multiple files or folders is not supported, but it can be achieved using macros.

  • The output action Append is not supported. Use Read > Union > Overwrite to replicate append behavior.

  • When creating a new file, if a file with the same name already exists at the destination, the action will not overwrite it. Instead, it will append a timestamp suffix to the new file's name, retaining both files.

  • Reading multi-sheet XLSX files or selecting a sheet by name or index is not supported.

  • Path scoping is limited to My Files. Recent and Shared with Me are not browsable/ accessible through OneDrive.

Version

Description

v3.1.1

  • Improved the Authority URL field with a pre-filled default value and inline help text, reducing the need to consult external documentation.

  • Fixed an issue where selecting an unsupported file format in the OneDrive Input connector would show irrelevant configuration options.

  • Fixed an issue where Test Connection failed in DCM when using the Built-in App authentication type.

  • Improved error handling for OneDrive In and Out operations.

v3.1.0

  • Compatible with Designer 2021.4.2 Patch 4, 2022.1 Patch 2 and later.

  • Ability to connect to OneDrive using Microsoft's secure OAuth 2.0 login.

  • Authenticate with a Service Principal for automated, unattended workflows.

  • Store your login once via DCM and reuse it across workflows on both Designer and Server.

  • Run unattended jobs on Server with automatic token refresh, no manual re-authentication needed.

  • Quickly filter to Personal Files, Shared with Me, or Recent Files.

  • Pick files by browsing, typing a path manually, or simply pasting a shared OneDrive link.

  • Paste a URL and the connector automatically identifies and loads the file's details.

  • Choose a specific sheet by name or number, define a custom cell range, or pull just the list of sheet names.

  • Bring in details like file name, path, size, last modified date, and file type alongside your data.

  • Retrieve just the file/folder structure without downloading full file contents.

  • Read .csv, .xlsx, and .yxdb files directly from OneDrive.

v2.3.0

  • Compatible with Designer 2021.4.2 Patch 4, 2022.1 Patch 2 and later.

  • Compatible with AMP engine only.

  • DCM is required for running this connector on Alteryx Server.

  • Improved the authentication options window.

  • OneDrive Input’s output now includes the sheet names when you download XLSX files locally. You can use the sheet names in other tools of your workflow.

  • Fixed issue where OneDrive Output set to overwrite a specific sheet in XLSX file modified other sheets as well.

  • Fixed issue where the OneDrive tools' authentication didn't work properly. (TPM-3833)

  • Fixed issue where OneDrive Input didn't read certain data types correctly. (TPM-3751, TPM-3722, TPM-3721)

  • Fixed issue where OneDrive Output wrote incorrect files if the data contained Fixed Decimal or Null values. (TPM-3720)

  • Fixed issue where OneDrive Output incorrectly converted Null values in CSV files. (TPM-3719)

  • Fixed issue where the service principal authentication didn't work in OneDrive Output. (TPM-3580)

  • Fixed issue where, despite user’s settings to exclude the field of the Select Sheet options, OneDrive Output included the field in the output. (TPM-3393)

  • Fixed issue where OneDrive Output didn't correctly append data. (TPM-2564)

  • Fixed issue where OneDrive Output’s Abort option didn't work correctly for all data types. (TPM-2563)

  • Fixed the OneDrive tools' encoding issues. (TPM-1984)

  • Fixed issue where OneDrive Output changed the headers' format. (TPM-1375)

  • Fixed issue where OneDrive Output’s Append option overwrote document’s formatting and formulas. (TPM-1179)

  • Fixed issue where OneDrive Input couldn't read YXDB files with DateTime data. (TPM-1100)

  • Fixed issue where OneDrive Output fails when the workflow includes data of Byte and Int16 data types. (TPM-209)

v2.2.0

  • Compatible with Designer 2021.4.2 Patch 4, 2022.1 Patch 2 and later.

  • Compatible with AMP engine only.

  • Added support for DCM.

    • DCM is required for running this connector on Alteryx Server.

  • FIPS capable.

  • Added option to overwrite only one sheet.

  • Changed the behavior of sheet name field to be excluded from the written data. Added option to keep the sheet name field.

  • SSL/TLS validation is now performed against Windows Certificate Store.

v2.1.0

  • Authentication occurs using user's browser instead of embedded CEF in Designer to comply with modern security policies.

v2.0.2

  • Fixed issue with tool configuration being lost in case of "Provide authentication Information" being enabled.

v2.0.1

  • Fixed blank screen issue when authenticating in Designer 2021.3.2.54175. Please note that you also need to update to Designer 21.3.3.63061 or later.

v2.0.0

  • Built-in multitenant Azure App with an option to use a custom Azure App (including single-tenant app or Service Principal).

  • Supports reading and writing XLSX, CSV, and YXDB file formats.

  • Proxy support.

  • Compatible with Designer version 2021.2.2 and later.

  • Requires OneDrive 365.

v1.0.2

  • Update Code Page options.

  • Distinguish between encodings with same language (for example, 'Language' -> 'Language (specific code)') and ordered encodings alphabetically.

  • Allow user to specify encoding for CSV files on output tool.

  • Improved data conversion handling to not throw a warning instead of an error when a field is missing a value.

  • Fix issue where default value settings were occasionally not respected.

  • Disabled production logging to prevent permissions issues for different installations/configurations of Designer and support scheduled workflow functionality.

v1.0.1

  • Fixed issue preventing packages from being installed successfully.

v1.0.0

  • Initial release for OneDrive Input and OneDrive Output.

Alteryx Tools Used to Connect

Enable AMP Engine

Make sure you have the AMP engine enabled for the workflows that contain the OneDrive tools version 2.2.0 and later.

Custom Microsoft Azure API Application Setup

To set up a custom API application for this tool, go to our guide.