Get Sharing Information
Description
Get Sharing Information step retrieves the sharing information of a file or folder from the Document Library present in a specified site in SharePoint Online.
API Reference:
https://learn.microsoft.com/en-us/graph/api/driveitem-list-permissions?view=graph-rest-1.0&tabs=http
Prerequisites
You require the following permissions for app on Azure:
| Permission Type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
| Delegated (personal Microsoft account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All |
| Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Configuration
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Specify the name of the step. This name must be unique within a single workflow. This is a mandatory step. |
| Connection: | ||
| 2 | Client ID | Specify the Client ID of the SharePoint App. For information about creating a client ID, see Appendix: SharePoint: App Registration & Refresh Token Generation. The field data type is String. This is a mandatory field. |
| 3 | Accept value as variable/static | Select the checkbox if you want to enter the Refresh Token name in the Refresh Token field. If you do not select the checkbox, then you can select the refresh token from the Refresh Token field. |
| 4 | Refresh Token | Specify or select the Refresh Token generated using the Client ID, which is created after registering the app in Azure AD. This is a mandatory field. |
| 5 | Test Connection | Verifies whether the connection is successfully established. Note: This connection will not work with variables from the previous step. The Test Connection button only works with static values and environment variables. |
Input Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Base Site URL | Specify the SharePoint site-relative URL. Format: {Tenant Name}.sharepoint.com:/{SharePoint Site Path} Example: firstUser.sharepoint.com:/sites/TestingSite This is a mandatory field. Note: For the root site (Communication Site), you do not need to specify the {SharePoint Site Path}. |
| 2 | Document Library Name | Specify the name of the Document Library in which the file or folder is present. This is a mandatory field. |
| 3 | File or Folder Path | Specify a valid SharePoint file or folder path for which you want to retrieve sharing information. This is a mandatory field. |
| 4 | Select Properties | Enter the property names to fetch. For example: name, id By default, all properties will be fetched. Example: id, name, weburl. |
Output Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | JSON Output | Specify a field to define the output variable name. The default output variable name is JSONOutput. On successful execution, it holds the output of the plugin step in JSON format. |