In this article
Table of Contents | ||||
---|---|---|---|---|
|
Overview
You can use this Snap to 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.
...
Snap Type
SharePoint Online - Get Item Permissions Snap is a Read-type Snap.
Prerequisites
- Valid SharePoint
Valid SharePoint Online tenant and associated site.
Valid Azure application with all the required API permissions.
Support for Ultra Pipelines
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra
...
Pipeline.
...
To To know the list of Snaps that work in Ultra and the related caveats, see see Snap Support for Ultra Pipelines.
Limitations and Known Issues
None.
Snap
...
Views
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 |
Snap Settings
Label
String
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. |
Snap Settings
Info |
---|
|
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
String
Site* Default Value: N/A |
SharePoint Online - Get Item Permissions
Example: MySite | String/Expression | Specify the name of a site |
which contains the list of document library to be used in the subsequent Snap settings. |
MySite
Custom Site Path |
Multiexcerpt include macro name ME_Custom Site Path page SharePoint unsafe-Online - Get Item
Document Library
String
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. |
N/A
Shared Documents
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
Select fields Default Value: N/A |
Example: id, email, roles | 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. |
This fieldset comprises the following fields:
Required. This property enables you to set
| ||
Connection timeout* |
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 |
Snap Execution
String
Specify the time interval in seconds between connection attempts. |
Snap Execution Default Value: Validate & Execute | Dropdown list | Specify the required Pipeline execution type:
|
Execute only
Validate & Execute
Info |
---|
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).
...
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.
...
Downloads
Noteinfo | |
---|---|
title | Important Steps to Successfully Reuse Pipelines
|
Attachments | ||
---|---|---|
|
Snap Pack History
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
See Also
...
Related Content
...
...