In this article

Use this Snap to modify the Share Permissions defined for a driveItem in your OneDrive or Shared Library (Document Library), at a given point in time.

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.

...

Only organizational users can update the role if the Share Type is invite. When an anonymous user attempts to update the role, the Snap throws a 400 error.
Only anonymous users can update the expiry date if the Share Type is link. When an organizational user attempts to update the expiry date, the Snap throws a 400 error.

Known Issues

Snaps in the Microsoft OneDrive Snap Pack have an in-built retry mechanism for retrying failed 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	Document	Min: 0 Max: 1	Mapper Copy Get Share Permissions Copy Item	A document containing the driveItem location details to modify the Share Permissions currently available on it.
Output	Document	Min: 1 Max: 1	Mapper Copy Get Share Permissions Get Shared Items	A document containing the result of modifying the selected Share Permissions on the selected driveItem.

Snap Settings

Parameter Name

Data Type

Description

Default Value

Example

Label

String

Insert excerpt

	File Writer
	File Writer
nopanel	true

Update Share Permissions

Drive Type

Drop-down list

Required. Select a drive type from the following list of permitted driveTypes in this drop-down list (to locate driveItems and update their share permissions) and specify the corresponding details needed:

OneDrive. To update the share permissions on a driveItem in a OneDrive location. Requires User, Drive, and Source Relative Path/ID.
documentLibrary. To update the share permissions on a driveItem in a shared library (document library) location. Requires Shared Library, Drive, and Source Relative Path/ID.
Drive. To update the share permissions on a driveItem in a drive (in user's OneDrive or shared library) using the Drive ID. Requires Drive (ID) and Source Relative Path/ID.
All. To select a drive from the list of all drives and shared libraries (including SharePoint sites) that you can access, and update the share permissions on a driveItem in that location. 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 update the share permissions on a driveItem from that user's OneDrive location.

Info
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 update the share permissions on a driveItem from that library location.

Info
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 update the share permissions on the driveItem in it. 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 update the share permissions on a driveItem in it, 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, beginning with root:/, to update the share permissions. Alternatively, pass the item ID in this field.

Info

title	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:/

/myprojects/myfile.xlsx

Share Type

Drop-down list

Choose an option from the list to update share permissions. Available options are:

invite.: The share permission is sent through an invite.
Note
On selecting invite, Role field is enabled to update organizational user role. Role permissions cannot be updated for anonymous share/user.
link
.
: The Share permission is sent through a link.
Note
On selecting link, Expires field is enabled to update expiry date and time. Organization user permissions cannot be updated. Applies only for anonymous user.

invite

link

Permission ID

String/Expression/Suggestion

Required. Enter, or select from the suggested list, the existing permission IDs on the selected driveItem to update the corresponding share permissions.

N/A

8b36234d-fed2-44d5-b507-e1be36d14a37

Roles

Drop-down list

Activates on selecting invite in Share Type field.

Select one of the following options from this drop-down list to update the share permissions on that driveItem.

read. To change the share permissions for the driveItem from write to read.
write. To change the share permissions for the driveItem from read to write.

read

write

Expires

String

Activates on selecting link in Share Type field

Specify the expiry date and time of the URL that is used to share permissions.

N/A

2020-09-29T04:18:00.000

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

...

Error	Reason	Resolution
Error while creating item invite, Reason: 400 : Bad Request	Require SignIn cannot be false for folders.	Select the Require Signin check box while sharing the item and try again.

Examples

Working with Share

...

Permissions (Share Type: Link) in OneDrive

This Pipeline demonstrates how you can share permissions to an anonymous user through a link option. We assume that you have configured your Azure application and the Snap accounts. The Pipeline uses the following parameters.
Image Modified

We start with configuring a JSON Generator Snap by providing input text, which generates a new JSON as a document for the downstream Snap. Next, we configure the JSON Formatter Snap that reads the passed on document stream and writes the JSON binary data to output.

Then, we upload a file processed from the previous Snaps using Upload File Snap, and configure the fields accordingly.

...

Finally, we configure the Update Share Permissions Snap with the required inputs and set an expiry date and time for the link.

Upon execution we have an output with updated expiry Date and Time for the shared link.

...

We start with creating a new folder using the Create Folder Snap and then, share it with a recipient using Share Item Snap. Next, we update the share permissions for the item and delete them after use.

Create Folder Snap

Output
Image RemovedImage Added

To share the item, we need to define the type of share, the recipients, roles, scope of share, expiry period, and so on, depending on our need. If you have selected the Share Type as Invite, you can update the share permissions on the item later.

...

After sharing the item, we use a Mapper to extract the Permission ID and the path of the shared item.

Mapper Snap
Image RemovedImage Added
Output

We pass this information to the Get Share Permissions Snap to fetch all the existing shared permissions on this folder (including the inherited share permissions).

Get Share Permissions Snap

Output
Image RemovedImage Added

Now, we pass these permission Ids retrieved to Update Shared Permissions Snap to change the permissions from read to write.

Update Shared Permissions Snap

Output
Image RemovedImage Added

Using the Update Share Permissions Snap, we have updated all the existing share permissions to write access on the driveItem. We can now retrieve these permissions and delete them as and when needed. To do this, we use another Mapper Snap to capture the updated permission IDs, relative paths and delete them using the Delete Share Permissions Snap.