In this article

Overview

This snap creates a sharing invitation for a driveItem for the configured set of recipients. A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Prerequisites

Use valid SharePoint Online tenant and associated site in account and snap settings respectively.
Valid application in Azure portal with necessary permissions to the application. To learn more about how to choose permissions, see Permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines.

See Snap Support for Ultra Pipelines.

Limitations and Known Issues

N/A

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
... ...

A document containing the metadata of the permission to be created.

Output

Document

Min:0
Max:1

Mapper Snap
Copy Snap
CSV Parser
JSON Parser
... ...

A document containing the created (or shared) permissions on the item with the recipients.

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 - Create Permission
Site	String	Required. This property enables you to define the name of a site, which contains the list of document library to be used in the subsequent settings.	N/A	MySite
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 dropdown. Users are allowed either to choose a document library from suggestion dropdown or type an entity manually. Note If an expression is used in the Site property, then the document library will not be suggested.	N/A	Shared Documents
Source item relative path	String	Required. The driveItem resource path that represents a file, folder, or other item stored in a document library on which we want to create the permission.	N/A	testFile.pdf
Roles	String	Required. Specify the roles that are to be granted to the recipients of the invitation.	Read	Write
Recipients	String	Required. Comma-separated recipients who will receive access and the sharing invitation to the selected item.	N/A	user@company.com
Message	String	Optional. A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.	N/A
Require signin	boolean	Optional. Enable this property to send the invitation to sign-in to view the shared item with the recipients.	Disabled
Send invitation	boolean	Optional. Enable to send a sharing link to the recipient. Otherwise, a permission is granted directly without sending a notification.	Disabled
Connection details	N/A	Settings to influence connection properties to the SharePoint Online APIs.	N/A	N/A
Connection timeout	int	Required. This property enables you to set the connection timeout duration in seconds.	30	30
Number of retries	int	Required. This property enables you to set the maximum number of re-connections in case of connection failure or timeout.	0	0
Retry interval (seconds)	int	Required. This property enables you to set the time interval in seconds between connection attempts.	1	1
Snap Execution	DropDown	Specifies the 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	N/A

For more information on how to update an item permissions in the SharePoint Online please refer to the graph API, see Change Sharing-permissions.

Troubleshooting

Error	Reason	Resolution
HTTP Response Code:404	Entered item not found in the document library	Please ensure to provide the valid item path to get the metadata.
Forbidden exception:403	Either user or app don'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

The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).

The following SharePoint Online - Create Item Permission snap and pipeline shows how to create a permission on a specified item.

Configuration of the SharePoint online update item permission snap is shown as below.

A successful validation or execution of the Snap gives the following output preview, showing the results.

Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Furnish Pipeline parameters as applicable.

	File	Modified
Labels No labels Preview View	File SP_1.0.0_CreatePermission_2020_05_29.slp	Jun 04, 2020 by Rojo Publisher (Unlicensed)

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'EXPORTSPACE:<Deprecated>SharePoint Online Snap Pack'.

SnapLogic Documentation

SharePoint Online - Create Item Permission