Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

Use this Snap to retrieve the Share Permissions existing on a driveItem in a OneDrive or Shared Library (document library) locationat a given point in time. Each permission has a unique alpha-numeric case-sensitive ID.

...

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/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • Update Permissions
A document containing the driveItem location details to retrieve the list of Share Permissions currently available on it.
Output

Document

  • Min: 1
  • Max: 1
  • Mapper
  • Delete Permissions

A document containing the list of Share Permissions existing on the selected driveItem.

...

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Insert excerpt
File Writer
File Writer
nopaneltrue
Get Share PermissionsGet Share Permissions
Drive TypeDrop-down list

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

  • OneDrive. To get the share permissions on a driveItem in a OneDrive location. Requires UserDrive, and Source Relative Path/ID.
  • documentLibraryTo get the share permissions on a driveItem in a shared library (document library) location. Requires Shared LibraryDrive, and Source Relative Path/ID.
  • DriveTo get the share permissions on 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 get the share permissions on a driveItem from that locationRequires UserDrive, and Source Relative Path/ID.
OneDrivedocumentLibrary
UserString/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 get 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/ASnap Team:snap@snaplogic.net
Shared LibraryString/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 get the share permissions on the driveItem in 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/ANewSharedLibrary
DriveString/Expression/Suggestion

Required for all Drive Type options.

Specify the name of the drive to get 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 get 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/AOneDrive
Source Relative Path/IDString/Expression

Required for all Drive Type options.

Enter the relative path for the driveItem to get the share permissions, beginning with root:/. Alternatively, pass the item ID in this field.

Info
titleRelative 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 as 014ZXBQNNHW2DJ3CDKQZBJHRYWFWVRRQA2), the Snap fails the Snap returns the error - The resource is not found.


root://Pictures/Tour1/Image01.png
Select FieldsString/Expression

Enter the list of different parameters, separated by a comma, that you want to retrieve for each Share permission existing on the selected driveItem.

Info

The Snap returns all the available information on the selected driveItem, if this field is left blank.


N/Aid, email, roles
Number Of RetriesString/ExpressionSpecify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.03
Retry Interval (Seconds)String/ExpressionEnter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached.12
Snap ExecutionDrop-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.

Validate & ExecuteExecute only

...

In this scenario, the driveItem (new folder) has not inherited any permissions from its parent item. We can use a Mapper Snap to view a simplified output that contains only fields that we want to analyze.

Mapper Snap

Output

Download this Pipeline

Example 2: 

Working with Share Permissions in OneDrive

...

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

Download this Pipeline

Downloads

Note
titleImportant Steps to Successfully Reuse Pipelines
  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

...