Overview

Use this Snap to share a driveItem with internal and external users/stakeholders allowing them to either view or edit the driveItem contents (files and folders).

Prerequisites

A valid application in Azure Portal with appropriate permissions.
A valid Microsoft OneDrive license.
Write access to the folder/file mentioned in the Source Relative Path/ID.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

None.

Known Issues

Snaps in the Microsoft OneDrive Snap Pack have an in-built retry mechanism for failing connections and requests; but, a high volume of requests from a client might reach the throttling threshold. In such scenarios, the Microsoft Graph limits further requests from that client for a period of time and returns an HTTP status code 429 (Too many requests), thereby causing the requests to fail. Hence, we recommend you to keep a check on the number of requests emanating from your client instance.

Snap Input and Output

Input/Output	Type of View	Number of Views	Examples of Upstream and Downstream Snaps	Description

Input/Output	Type of View	Number of Views	Examples of Upstream and Downstream Snaps	Description
Input	Document	Min: 0 Max: 1	Mapper Copy Get Drive Item Get Share Permissions Create Folder	A document containing the details of the driveItem to share and the specifics of the access being provided (recipients, expiry, link, and so on).
Output	Document	Min: 1 Max: 1	Mapper Copy Update Share Permissions Delete Share Permissions	A document containing the result and details of the share/access provided and the list of recipients.

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example

Parameter Name	Data Type	Description	Default Value	Example
Label	String		Share Item	Share Files in my Drive
Drive Type	Drop-down list	Required. Select a drive type from the following list of permitted driveTypes in this drop-down list (to share a driveItem) and specify the corresponding details needed: OneDrive. To share a driveItem from a OneDrive location. Requires User, Drive, and Source Relative Path/ID. documentLibrary. To share a driveItem from a shared library (document library) location. Requires Shared Library, Drive, and Source Relative Path/ID. Drive. To share a driveItem from a drive (in user's OneDrive or shared library) using the Drive ID. Requires Drive (ID) and Source Relative Path/ID. All. To share a driveItem from a drive from the list of all drives and shared libraries (including SharePoint sites) that you can access. Requires User, Drive, and Source Relative Path/ID.	OneDrive	documentLibrary
User	String/Expression/Suggestion	Required for Drive Type options - OneDrive and All. Not needed for Drive and documentLibrary. Select a user from the suggested list of users to share a driveItem from that user's OneDrive location. The list of users displayed varies based on your access to their OneDrive locations. This option is meant for administrator users who are authorized to manage other users' drives, as well.	N/A	Snap Team:snap@snaplogic.net
Shared Library	String/Expression/Suggestion	Required for Drive Type option - documentLibrary. Not needed for OneDrive, Drive, and All. Select a Shared Library from the suggested list of libraries to share a driveItem from that library location. The list of shared libraries displayed varies based on your access to them. This option is meant for users who have write access on both the source and target shared libraries.	N/A	NewSharedLibrary
Drive	String/Expression/Suggestion	Required for all Drive Type options. Specify the name of the drive to share a driveItem from. The suggestions for this field are based on the Snap account and the User or Shared Library selected. For the Drive Type Drive, specify/pass the ID of the drive to share a driveItem from, typically from the upstream Snap. For the drive type All, select a drive from the OneDrive or a Shared Library drive. Specify the Source Relative Path/ID of the driveItem, next.	N/A	OneDrive
Source Relative Path/ID	String/Expression	Required for all Drive Type options. Enter the relative path for the driveItem to share, beginning with root:/. Alternatively, pass the item ID in this field. Relative Path and ID Any URL in this field that starts with root:/ is treated as relative path. All other entries (without root:/ at the beginning) are treated as driveItem IDs. When the driveItem ID passed is invalid (not a 34-character alphanumeric code such as 014ZXBQNNHW2DJ3CDKQZBJHRYWFWVRRQA2), the Snap returns the error - The resource is not found.	root:/	/Pictures/Tour1/
Share Type	Drop-down list	Select a share type to specify the method for sharing the driveItem from the following two options: invite. To invite the recipient through an e-mail, authenticate and allow access to the driveItem. You can update share permissions for these driveItems later. Requires Roles. link. To create a link for the driveItem and allow the recipients access the driveItem using this link. Requires Roles and Share.	invite	link
Roles	Drop-down list	Required for both share types - invite and link. Select the role / permitted operations that the recipients of the invite or link can perform on the shared driveItem, from the following two options. read. To allow the recipients to view the shared driveItem and its details. write. To allow the recipients to view and edit/modify the driveItem and its details.	read	write
Share	Drop-down list	Required for Share Type - link. Select the background of the link recipients from the following two options. organization. To make the link work as expected only when the recipient is part of the same organization (can authenticate in the organization's domain/network). anonymous. To make the link work as expected for any user who has this link.	organization	anonymous
Recipients	Required for Share Type - link. Use this field set to add recipients to allow them access the driveItem. Click to add a new row in this table and specify the email address accordingly. This field set consists of the following fields: Recipients
Recipients	String/Expression/Suggestion	For recipients within the organization, select the email address from the suggested list. Multiple email addresses in the same row You can select only one recipient per each row from the suggestions list. But, you can fill this field with a comma-separated list of email addresses either manually or from an upstream Snap.	N/A	John.doe@yourcompany.com
Expires	String/Expression	Required for Share Type - link where Share is Anonymous. Specify the date-time when you want the link to expire. This field is not required when Share is set to Organization.	N/A	2021-03-31T00:00:00
Require SignIn	Check box	Required for Share Type - invite. Select this check box if you want the user to authenticate the identity (email address or otherwise) in order to access the shared driveItem.	Selected	Not selected
Send Invitation Notification	Check box	Required for Share Type - invite. Select this check box if you want the user to receive a notification about the invite to access the shared driveItem. Invitation Notification The Snap does not send Invitation Notifications to the recipients, unless you select this check box. In such cases, the driveItem will be available for the users to access under their Shared Libraries section, but without any notification.	Selected	Not selected
Share Message	String/Expression	Required for Share Type - link and invite. Enter the message for the recipients about the driveItem you are sharing.	N/A	Use this file as a reference.
Number Of Retries	String/Expression	Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.	0	3
Retry Interval (Seconds)	String/Expression	Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached.	1	2
Snap Execution	Drop-down list	Select one of the three following modes in which the Snap executes: Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled. Disables the Snap and all Snaps downstream from it.	Execute only	Validate & Execute