OneDrive

Use OneDrive to upload, download, search, and organize files and folders. The actions below also cover metadata, copying or moving items, sharing links, and deletion.

OAuth scopes

Sim requests these scopes when someone connects an OneDrive account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

Setting	Value
Redirect URI	`<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/onedrive`
Environment variables	`MICROSOFT_CLIENT_ID`, `MICROSOFT_CLIENT_SECRET`

Scope	Description
`openid`	Standard authentication
`profile`	Access profile information
`email`	Access email address
`Files.Read`	Read OneDrive files
`Files.ReadWrite`	Read and write OneDrive files
`offline_access`	Access account when not using the application

Use the block

Create text and Excel files, upload files, download files, list and search files, move or rename files, copy files, create sharing links, and delete files or folders.

Actions

Upload to OneDrive

Upload a file to OneDrive

Inputs and outputs

Input

Parameter	Type	Required	Description
`fileName`	string	Yes	The name of the file to upload (e.g., "report.pdf", "data.xlsx")
`file`	file	No	The file to upload (binary)
`content`	string	No	The text content to upload (if no file is provided)
`mimeType`	string	No	The MIME type of the file to create (e.g., text/plain for .txt, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for .xlsx)
`folderId`	string	No	Folder ID to upload the file to (e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M")

Output

Parameter	Type	Description
`success`	boolean	Whether the file was uploaded successfully
`file`	object	The uploaded file object with metadata including id, name, webViewLink, webContentLink, and timestamps

Create Folder in OneDrive

Create a new folder in OneDrive

Inputs and outputs

Input

Parameter	Type	Required	Description
`folderName`	string	Yes	Name of the folder to create (e.g., "My Documents", "Project Files")
`folderId`	string	No	Parent folder ID to create the folder in (e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M")

Output

Parameter	Type	Description
`success`	boolean	Whether the folder was created successfully
`file`	object	The created folder object with metadata including id, name, webViewLink, and timestamps

Download File from OneDrive

Download a file from OneDrive

Inputs and outputs

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	The ID of the file to download (e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M")
`fileName`	string	No	Optional filename override (e.g., "report.pdf", "data.xlsx")

Output

Parameter	Type	Description
`file`	file	Downloaded file stored in execution files

List OneDrive Files

List files and folders in OneDrive

Inputs and outputs

Input

Parameter	Type	Required	Description
`folderId`	string	No	Folder ID to list files from (e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M")
`query`	string	No	Filter files by name prefix (e.g., "report", "invoice_2024")
`pageSize`	number	No	Maximum number of files to return (e.g., 10, 50, 100)
`pageToken`	string	No	Continuation URL from a previous response's nextPageToken, used to fetch the next page

Output

Parameter	Type	Description
`success`	boolean	Whether files were listed successfully
`files`	array	Array of file and folder objects with metadata
`nextPageToken`	string	Token for retrieving the next page of results (optional)

Search OneDrive Files

Search for files and folders across OneDrive by name, metadata, or content (recursive)

Inputs and outputs

Input

Parameter	Type	Required	Description
`query`	string	No	Search text matched against file name, metadata, and content. Not required when paginating with pageToken
`pageSize`	number	No	Maximum number of results to return (e.g., 10, 50, 100)
`pageToken`	string	No	Continuation URL from a previous response's nextPageToken, used to fetch the next page

Output

Parameter	Type	Description
`success`	boolean	Whether the search completed successfully
`files`	array	Array of file and folder objects matching the search query
`nextPageToken`	string	Token for retrieving the next page of results (optional)

Get OneDrive Item Metadata

Get metadata for a specific OneDrive file or folder by ID, or the drive root

Inputs and outputs

Input

Parameter	Type	Required	Description
`fileId`	string	No	The ID of the file or folder to retrieve (e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"). Leave empty to get the drive root folder

Output

Parameter	Type	Description
`success`	boolean	Whether the item metadata was retrieved
`file`	object	The file or folder metadata, including id, name, webViewLink, size, and timestamps

Get OneDrive Info

Get information about the OneDrive drive, including storage quota

Inputs and outputs

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
`success`	boolean	Whether the drive info was retrieved
`driveId`	string	The ID of the drive
`driveType`	string	The type of drive (e.g., "personal", "business")
`webUrl`	string	URL to the drive in the browser
`owner`	string	Display name of the drive owner
`quota`	object	Storage quota information in bytes (total, used, remaining, deleted, state)

Move or Rename OneDrive File

Move a file or folder to a new parent folder, rename it, or both

Inputs and outputs

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	The ID of the file or folder to move or rename
`destinationFolderId`	string	No	The ID of the destination parent folder (omit to only rename in place)
`newName`	string	No	The new name for the file or folder (omit to only move)

Output

Parameter	Type	Description
`success`	boolean	Whether the move or rename was successful
`file`	object	The updated file object with its new name and/or parent folder

Copy OneDrive File

Copy a file or folder to another location within OneDrive

Inputs and outputs

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	The ID of the file or folder to copy
`destinationFolderId`	string	Yes	The ID of the destination parent folder
`destinationFileName`	string	No	Optional new name for the copy (defaults to the original name)

Output

Parameter	Type	Description
`success`	boolean	Whether the copy request was accepted
`sourceFileId`	string	The ID of the file or folder that was copied
`name`	string	The requested name for the copy, if provided
`monitorUrl`	string	URL to poll for the status of the asynchronous copy operation (copy completes in the background)

Create a view or edit sharing link for a OneDrive file or folder

Inputs and outputs

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	The ID of the file or folder to share
`linkType`	string	No	Type of link to create: "view" (read-only), "edit" (read-write), or "embed"
`linkScope`	string	No	Who can use the link: "anonymous" (anyone), "organization" (tenant members), or "users" (specific people)

Output

Parameter	Type	Description
`success`	boolean	Whether the sharing link was created successfully
`link`	object	The created sharing link, including its type, scope, and URL

Delete File from OneDrive

Delete a file or folder from OneDrive

Inputs and outputs

Input

Parameter	Type	Required	Description
`fileId`	string	Yes	The ID of the file or folder to delete (e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M")

Output

Parameter	Type	Description
`success`	boolean	Whether the file was deleted successfully
`deleted`	boolean	Confirmation that the file was deleted
`fileId`	string	The ID of the deleted file

OneDrive

On this page