In this article
...
Overview
You can use this Snap provides the ability to update to update the permissions of an item permission associated with an item/folder of in the SharePoint Online document library.
...
- 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 |
|
| An input document contains the metadata of the permission to perform update. |
Output | Document |
|
| An output document contains the updated permissions of an item. |
...
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 - Update Item Permission | ||||||||
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. The item resource path that represents a file, folder, or other item stored in a document library on which we want to update the permission. | N/A | testFile.pdf | ||||||||
PermissionId | String | Required.Select the permission id from the drop-down option associated with an item selected in the Source file path property or else pass it as an expression from the input document. | N/A | Yzowby5jfGZlZGVyYXRlZGR | ||||||||
Roles | String | Required. Select the roles that need to be applied to the item. Possible values include Read/Write | Read | Read | ||||||||
Connection details | You can use this fieldset to influence connection properties to the SharePoint Online APIs. This fieldset comprises the following fields:
| |||||||||||
Connection timeout | Integer | Required. Enables you to set the connection timeout duration in seconds. | 30 | 30 | ||||||||
Number of retries | Integer | Required. Enables you to set the maximum number of re-connections in case of connection failure or timeout. | 1 | 0 | ||||||||
Retry interval (seconds) | Integer | Required. Enables you to set the time interval in seconds between connection attempts. | 10 | 1 | ||||||||
Snap Execution | String | Specify the required Pipeline execution type:
| Execute only | Validate & Execute |
...
This example demonstrates how to take the document library from the Mapper Snap and update the role/permission of the selected item to Read-Only. The example assumes that you have configured and authorized a valid SharePoint Online Account (see SharePoint Online Account).
The following screenshot displays the settings of the SharePoint Online Update Item Permission Snap.
...