In this article

Overview

You can use this Snap to get the permissions of an item from the SharePoint Online document library. Also, you can select the fields that you want to retrieve from the metadata.

SnapLogic Documentation > SharePoint Online - Get Item Permissions > get item permission.png

Prerequisites

Valid SharePoint Online tenant and associated site.
Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines.

To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.

Limitations and 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 Snap Copy Snap CSV Parser JSON Parser	An input document contains the data related to get the item permissions.
Output	Document	Min:1 Max:1	Mapper Snap Copy Snap CSV Parser JSON Parser	An output document contains an array with the collection of Permission resources in the response body.

Snap Settings

Parameter Name	Data Type	Description	Default Value	Example
Label	String	Required. The 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.	N/A	SharePoint Online - Get Item Permissions
Site	String	Required. The name of a site that contains the list of document library to be used in the subsequent settings.	N/A	MySite
Custom Site Path	Check-box		Not Selected	Selected
Document Library	String	Required. This property enables you to select Drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion drop-down. Users are allowed either to choose a document library from suggestion drop-down or type an entity manually.	N/A	Shared Documents
Source item relative path	String	Required. Provide the item resource path that represents a file, folder, or other item stored in a document library to get the available permissions on the item.	N/A	testFile.pdf
Select fields	String	Optional. Enter the comma-separated properties to be written to the output view.	N/A	id, roles
Connection details	You can use this fieldset to influence connection properties to the SharePoint Online APIs. This fieldset comprises the following fields: Connection timeout Number of retries Retry interval (seconds)
Connection timeout	Integer	Required. This property enables you to set the connection timeout duration in seconds.	30	30
Number of retries	Integer	Required. This property enables you to set the maximum number of re-connections in case of connection failure or timeout.	3	1
Retry interval (seconds)	Integer	Required. This property enables you to set the time interval in seconds between connection attempts.	10	10
Snap Execution	String	Specify the required Pipeline execution type: Validate & Execute. Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution. Execute only. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation. Disabled. Disables the Snap and, by extension, its downstream Snaps.	Execute only	Validate & Execute

For more information on how to delete an item in the SharePoint Online, refer to the graph API in Get-item-permissions.

Troubleshooting

Error	Reason	Resolution
HTTP Response Code:404	Entered item not found in the document library	Ensure to provide the valid item path to get the metadata.
Forbidden exception:403	Either user or app doesn't have sufficient permissions to read the metadata for the document library.	Ensure to provide the desired permissions both at the user and application level.

Examples

Listing Permissions of an Item

This example demonstrates how to list the permissions of a particular item. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).

SnapLogic Documentation > SharePoint Online - Get Item Permissions > Sharepoint-get-permissions-snap.png

The following screenshot displays the settings of the SharePoint Online - Get Item Permissions Snap. The Snap specifies to list the item permissions only its IDs.

SnapLogic Documentation > SharePoint Online - Get Item Permissions > Sharepoint-get-permissions-settings.png