In this article

Overview

Use this Snap to delete the Share Permissions existing on a driveItem, in a OneDrive or Shared Library (document library) location, 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.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

None.

Known Issues

None.

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	A document containing the driveItem location details to delete one or more Share Permissions currently available on it.
Output	Document	Min: 1 Max: 1	Mapper Share Item	A document containing the result of deleting the selected Share Permissions on the selected driveItem.

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example
Label	String	Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.	Delete Share Permissions	Delete 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 delete their share permissions) and specify the corresponding details needed: OneDrive. To delete the share permissions on a driveItem in a OneDrive location. Requires User, Drive, and Source Relative Path/ID. documentLibrary. To delete the share permissions on a driveItem in a shared library (document library) location. Requires Shared Library, Drive, and Source Relative Path/ID. Drive. To delete 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 delete 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 delete the share permissions on 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 delete the share permissions on 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 delete 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 delete 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 delete the share permissions. 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:/	/myprojects/myfile.xlsx
Permission ID	String/Expression/Suggestion	Required. Enter, or select from the suggested list, the permission IDs on the selected driveItem to delete the corresponding Share permission on the driveItem.	N/A	8b36234d-fed2-44d5-b507-e1be36d14a37
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

Troubleshooting

Error

Reason

Resolution

Examples

Working with Share Permissions in OneDrive

This Pipeline demonstrates how you can share an item and how we can get/update/delete the share permissions existing on a drive item. It assumes that you have configured your Azure application and the Snap accounts already. The Pipeline uses the following parameters.

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

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.

Share Item Snap	Output

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

Mapper Snap

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

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

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.

Mapper Snap

Output

Delete Shared Permissions Snap

Output

This Snap deletes the share permissions on the driveItem and displays the result of the operation for each permission ID.

Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.

	File	Modified
Labels No labels Preview View	File Example_OneDrive_Share_Item_Get_Update_Delete_Share_Permissions.slp	Mar 02, 2022 by Subhajit Sengupta

Snap Pack History

Click here to expand...

Release	Snap Pack Version	Date	Type	Updates
August 2024	438patches28439	21 Oct 2024	Latest	Updated the Kotlin library for Microsoft OneDrive Snap Pack with the `okhttp` library Platform version to avoid Kotlin library dependency conflict.
August 2024	main27765	21 Aug 2024	Stable	Updated and certified against the current SnapLogic Platform release.
May 2024	main26341	08 May 2024	Stable	Updated and certified against the current SnapLogic Platform release.
February 2024	436patches25789	22 Apr 2024	Latest	Fixed a performance issue in the Copy Item Snap, which previously resulted in a `nameAlreadyExists` error when the Snap retried because of a connection reset.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	434patches22736	07 Sep 2023	Latest	Fixed an issue with the Mircosoft OneDrive Snap Pack where the Snaps displayed `Duplicate key OneDrive` error. The Snaps now hide the drive details stored in the `PreservationHoldLibrary` folder when displaying suggestions. You can use the Drive ID to access the `PreservationHoldLibrary` folder. Fixed an issue with the Mircosoft OneDrive Snaps that displayed a `JsonNull` error when the shared library list was empty. Now, it displays the message `No Suggestions available`.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	432patches20510	08 May 2023	Latest	Fixed the following issues with OneDrive Snaps: The Snaps erroneously displayed the permission error when the actual cause was an empty display name in the API. The Snaps failed with a `403 error` when selecting a user (in the User field) from the Suggestions list without the `User.Read.All` permission. Now you can enter the value manually in the User field and proceed with the specific operation you want to perform in OneDrive, even if the Suggestions list is not available.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	main18944	10 Nov 2022	Stable	Upgraded with the latest SnapLogic Platform release.
August 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.29	main15993	14 May 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.28	main14627	12 Feb 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.27	main12833	13 Nov 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25 Patch	425patches10571		Latest	Updated the error output view of the OneDrive - Upload File Snap from a Binary view to a Document view.
4.25	main9554	14 Aug 2021	Stable	Enhanced the Update Share Permissions Snap with the Share Type and Expires fields that enable you to update the share permissions on your OneDrive items shared using the Invite or Link option. If the Share type is link, you can specify the expiry date and time for the URL that is used to share permissions.
4.24	main8556	13 Feb 2021	Stable	No updates made.
4.23	main73	14 Nov 2020	Stable	Initial release of the Snap Pack with the following Snaps and Accounts: Snaps: Check In File Check Out File Copy Item Create Folder Delete Item Delete Permissions Download File Get Children Get Drive Get Drive Item Get Share Permissions Move Item OneDrive - Search Share Item Shared/Recent Items Update Permissions OneDrive - Upload File Accounts: Microsoft OneDrive Application Account Microsoft OneDrive Dynamic Account Microsoft OneDrive User Account

SnapLogic Documentation

Delete Share Permissions