In this article
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.
SharePoint Online - Get Item Permissions Snap is a Read-type Snap.
Valid SharePoint Online tenant and associated site.
Valid Azure application with all the required API permissions.
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
None.
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | |
---|---|---|---|---|
Input | Document |
|
| An input document contains the data related to get the item permissions. |
Output | Document |
|
| An output document contains an array with the collection of Permission resources in the response body. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
|
Field Name | Field Type | Description | ||
---|---|---|---|---|
Label* Default Value: SharePoint Online - Get Item Permissions | String | Specify 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. | ||
Site* Default Value: N/A | String/Expression | Specify the name of a site which contains the list of document library to be used in the subsequent Snap settings. | ||
Custom Site Path Default Value: Deselected | Checkbox |
| ||
Document Library* Default Value: N/A | String/Expression | Specify the a 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 list. You can either choose a document library from suggestion drop-down list or enter the entity name manually. If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception. If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception. | ||
Source item relative path* Default Value: N/A | String/Expression | Specify the item resource path that represents a file, folder, or other item stored in a document library. | ||
Select fields Default Value: N/A | String/Expression | Enter the comma-separated properties to be written to the output view. | ||
Connection details | Use this field set to specify connection properties to the SharePoint Online APIs. | |||
Connection timeout* Default Value: 30 | Integer | Specify the connection timeout duration in seconds. | ||
Number of retries* Default Value: 3 | Integer | Specify the maximum number of reconnections in case of a connection failure or timeout. | ||
Retry interval (seconds)* Default Value: 10 | Integer | Specify the time interval in seconds between connection attempts. | ||
Snap Execution Default Value: Validate & Execute | Dropdown list | Specify the required Pipeline execution type:
|
For more information on how to delete an item in the SharePoint Online, refer to the graph API in Get-item-permissions. |
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. |
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).
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.
After successfully validating/executing the above Snap, the results display in the following output preview.
Important Steps to Successfully Reuse Pipelines
|