- Cyware Orchestrate
- Integrations
- IT Services
- Microsoft SharePoint
Microsoft SharePoint
App Vendor: Microsoft
App Category: IT Services
Connector Version: 1.1.0
API Version: 1.0.0
About App
The Microsoft SharePoint app allows you to manage SharePoint sites and files. The Microsoft SharePoint app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Create Item in a List | This action creates a new item within a specific SharePoint list. |
Delete Item from List | This action deletes a specific item from a SharePoint list using its unique identifier. |
List Groups | This action retrieves the list of available groups. This action requires one of the following permissions: groupmember.read.all, group.read.all, directory.read.all, group.readwrite.all, directory.readwrite.all. Note: In large organizations with more than 100 groups, use the Microsoft Entra ID app to retrieve all group IDs. |
List Operations on List | This action retrieves a collection of rich long-running operations associated with a specific SharePoint list. |
List Sites | This action retrieves the list of all available sites. |
Search for Sites | This action searches for SharePoint sites using the provided search terms. |
List Drives | This action retrieves the list of available drives for the given group. |
List Root Drive Items | This action retrieves the list of child items available in a drive. |
List Drive Item Children | This action retrieves the list of child items of a drive item in the root of the drive. This action can also retrieve the drive items from a top-level folder. |
Download File | This action downloads a file. |
Get Drive Item Details | This action retrieves the details about a given drive item. |
Get List Metadata | This action retrieves the metadata and properties for a specific list within a site. |
Get List Items | This action retrieves a collection of items from a specific SharePoint list. |
Simple Upload | This action uploads the files up to either 4MB or 60MB, depending on your environment. It is recommended to try this action before using the complex upload to reduce API calls and avoid API limits. |
Large File Upload | This action upload files up to either 4MB or 60MB depending on your environment. It is recommended to try this action before usingthe complex upload to reduce API calls and avoid API limits. |
Get Drive Item by Name | This finds a drive item by name. If the parent_id is specified, it will look in that parent's children for the drive item. |
Create Folder | This action creates a new folder. |
Create List | This action creates a new list within a specified SharePoint site |
Update a List Item | This action updates the column values and properties for an existing item in a SharePoint list. |
Generic Action | This is a generic action used to make requests to any Microsoft SharePoint endpoint. |
Configuration Parameters
The following configuration parameters are required for the Microsoft Sharepoint app to communicate with the Microsoft Sharepoint enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Tenant ID | Enter the tenant ID of the Azure instance to connect. Example: "example_tenant" | Text | Required | |
Client ID | Enter the client ID of the application that will be used to connect to Azure. Example: "09cd25c9-29b3-99ff-b49z-41235465b427" | Text | Required | |
Client Secret | Enter the client secret key of the application that will be used to connect to Azure. Example: "12345~123245123245abc~abc1234512345abc" | Password | Required |
Action: Create Item in a List
This action creates a new item within a specific SharePoint list.
Note
To perform this action, you must have the Sites.ReadWrite.All permission. No higher privileged permission is available for this action.
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameter
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context. Example: contoso.sharepoint.com | Text | Required | You can retrieve the site ID using the List Sites action. |
List ID | Enter the list GUID or display title to identify the specific list where the new item should be added. | Text | Required | |
Fields | Enter the column names and their corresponding values for the new item. Example: 'Title': 'Widget', 'Color': 'Purple' | Key Value | Required |
Action: Create List
This action creates a new list within a specified SharePoint site.
Note
To perform this action, you must have the Sites.Manage.All permission (least privileged) or the Sites.ReadWrite.All permission (higher privileged).
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context where the list will be created. Example: contoso.sharepoint.com | Text | Required | You can retrieve the site ID using the List Sites action. |
Display Name | Enter the user-facing display name for the new list. | Text | Required | |
List Template | Enter the template identifier to define the structure of the list. | Text | Optional | Default value: 'genericList' |
Extra Fields | Enter any additional properties, such as custom column definitions, to customize the list structure. | Key Value | Optional |
Action: List Groups
This action retrieves the list of available groups. This action requires one of the following permissions: groupmember.read.all, group.read.all, directory.read.all, group.readwrite.all, directory.readwrite.all.
Note: In large organizations with more than 100 groups, the Azure AD app should be used to get all group IDs.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the limit for the number of results returned. Example: 50 | Integer | Optional | Maximum limit:
Default value:
|
Example Request
[
{
"limit": 50
}
]Action: List Operations on a List
This action retrieves a collection of rich long-running operations associated with a specific SharePoint list.
Note
To perform this action, you must have the Sites.Read.All permission (least privileged) or one of the following higher privileged permissions: Sites.FullControl.All, Sites.Manage.All, or Sites.ReadWrite.All.
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameters
Parameters | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context. Example: contoso.sharepoint.com | Text | Required | You can retrieve the site ID using the List Sites endpoint. |
List ID | Enter the list ID or display name to identify the SharePoint list for which you want to retrieve operations. | Text | Required |
Action: List Sites
This action retrieves the list of all available sites.
Action Input Parameters
This action does not require any input parameter.
Action: Search for Sites
This action searches for SharePoint sites using the provided search terms.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query | Enter the query terms to search. Example: "contoso" | Text | Required |
Example Request
[
{
"query": "contoso"
}
]Action: List Drives
This action retrieves the list of available drives for the given group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | The group ID from which to get a list of drives. Example: "1e33b745-96a7-45a9-bx24-abc67208c69z" | Text | Required |
Example Request
[
{
"group_id": "b4c7526a-f529-433a-8279-fe8339042f5a"
}
]Action: List Root Drive Items
This action retrieves the list of the child items available in a drive.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID to retrieve child items. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required |
Example Request
[
{
"drive_id": "b!qt2SHtHOmEuYuN-SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko",
}
]Action: List Drive Item Children
This action retrieves the list of the child items of a drive item in the root of the drive. This action can also retrieve the drive items from a top-level folder.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID to retrieve child items. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required | |
Item ID | Enter the drive item ID to get children from. Example: "90leq7cbrymigwfdutoihyctxwvazvgks2" | Text | Required |
Example Request
[
{
"item_id": "016UQDHOMRV3HHWPR3OVE2ZI7YGL2PGZEV",
"drive_id": "b!qt2SHtHOmEuYuN-SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko"
}
]Action: List Operations on a List
This action retrieves a collection of rich long-running operations associated with a specific SharePoint list.
Note
To perform this action, you must have the Sites.Read.All permission (least privileged) or one of the following higher privileged permissions: Sites.FullControl.All, Sites.Manage.All, or Sites.ReadWrite.All.
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameters
Parameters | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context. Example: contoso.sharepoint.com | Text | Required | You can retrieve the site ID using the List Sites endpoint. |
List ID | Enter the list ID or display name to identify the SharePoint list for which you want to retrieve operations. | Text | Required |
Action: Delete Item from List
This action deletes a specific item from a SharePoint list using its unique identifier
Note
To perform this action, you must have the Sites.ReadWrite.All permission. No higher privileged permission is available for this action.
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameter
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context. Example: contoso.sharepoint.com | Text | Required | You can retrieve the site ID using the List Sites endpoint. |
List ID | Enter the list ID or display name to identify the SharePoint list that contains the item you want to delete. | Text | Required | |
Item ID | Enter the list item ID to identify the specific item you want to delete. | Text | Required |
Action: Download File
This action downloads a file.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID to retrieve child items. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required | |
Item id | Enter the drive item ID to download. Example: "90leq7cbrymigwfdutoihyctxwvazvgks2" | Text | Required |
Example Request
[
{
"item_id": "016UQDHOIJ7BAIBI4AOBAZOFPU2F77IOAE",
"drive_id": "b!qt2SHtHOmEuYuN-SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko"
}
]Action: Get Drive Item Details
This action retrieves the details about a given drive item.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID to retrieve child items. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required | |
Item ID | Enter the drive item ID to download. Example: "90leq7cbrymigwfdutoihyctxwvazvgks2" | Text | Required |
Example Request
[
{
"item_id": "016UQDHOMRV3HHWPR3OVE2ZI7YGL2PGZEV",
"drive_id": "b!qt2SHtHOmEuYuN-SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko"
}
]Action: Get List Items
This action retrieves a collection of items from a specific SharePoint list.
Note
To perform this action, you must have the Sites.Read.All permission (least privileged) or the Sites.ReadWrite.All permission (higher privileged).
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context. Example: contoso.sharepoint.com | Text | Required | You can retrieve the site ID using the List Sites action. |
List ID | Enter the list ID or display name to identify the SharePoint list from which you want to retrieve items. | Text | Required | |
Filter | Enter an OData filter query to retrieve only list items that meet specific criteria. Example: fields/Quantity lt 600. | Text | Optional | Allowed operators are eq, ne, lt, gt, le, ge, and startswith. |
Expand | Enter an OData expand query to include list item fields or related entities in the response. Example: fields(select=Name,Color) | Text | Optional |
Action: Get List Metadata
This action retrieves the metadata and properties for a specific list within a site.
Note
To perform this action, you must have the Sites.Read.All permission (least privileged) or the Sites.ReadWrite.All permission (higher privileged).
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context. | Text | Required | You can retrieve the site ID using the List Sites action. |
List ID | Enter the list GUID or the list title to identify the specific list to be retrieved | Text | Required | |
Select | Enter the select query parameter to limit the response to specific properties. Example: id, name, list. | Text | Optional | |
Expand | Enter the expand parameter to include related resources in the response. Example: columns, items(expand=fields) | Text | Optional |
Action: Simple Upload
This action uploads the files up to either 4MB or 60MB depending on your environment. It is recommended to try this action before using complex upload to reduce API calls and avoid API limits.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID of the target drive to upload. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required | |
Filename | Enter the local path to a file to upload to SharePoint. Example: "/tmp/912775e8-894d-41a2-a96b-f4936e037d7f/test.txt" | Text | Required | |
Parent ID | Enter the parent ID of the target folder to upload the file. Example: "90leq7cbrymigwfdutoihyctxwvazvgks2" | Text | Optional |
Example Request
[
{
"drive_id": "b!qt2SHtHOmEuYuN-SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko",
"filename": "/tmp/912775e8-894d-41a2-a96b-f4936e037d7f/test.txt",
"parent_id": "016UQDHOMRV3HHWPR3OVE2ZI7YGL2PGZEV"
}
]Action: Large File Upload
This action upload files up to either 4MB or 60MB depending on your environment. It is recommended to try this action before using complex upload to reduce API calls and avoid API limits.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID of the target drive to upload to. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required | |
Filename | Enter the local path to a file to upload to SharePoint. Example: "/tmp/912775e8-894d-41a2-a96b-f4936e037d7f/test.txt" | Text | Required | |
Parent ID | Enter the parent ID of the target item to upload to. Example: "90leq7cbrymigwfdutoihyctxwvazvgks2" | Text | Optional | |
Description | Enter the description of the uploaded file. Example: "A large file upload test" | Text | Optional | Default value:
|
Conflict behavior | Specify your preference to determine behavior if the file name is already taken. This can be rename, fail, or replace. Example: "replace" | Text | Optional | Allowed values:
Default value:
|
Example Request
[
{
"drive_id": "b!qt2SHtHOmEuYuN-SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko",
"filename": "/tmp/912775e8-894d-41a2-a96b-f4936e037d7f/test.txt",
"description": "A large file upload test",
"conflict_behavior": "replace"
}
]Action: Get Drive Item by Name
This will find a drive item by name. If the parent_id is specified, it will look in that parent's children for the drive item.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID of the target drive to upload to. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required | |
Drive Item Name | Enter the exact name of the drive item to search for. Example: "test_file.txt" | Text | Required | |
Parent ID | Enter the ID of a parent folder to look in. Example: "90leq7cbrymigwfdutoihyctxwvazvgks2" | Text | Optional |
Example Request
[
{
"drive_id": "b!qt2SHtHOmEuYuN-SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko",
"drive_item_name": "test_file.txt",
"parent_id": "90LEQ7CBRYMIGWFDUTOIHYCTXWVAZVGKS2"
}
]Action: Create Folder
This action creates a new folder.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Drive ID | Enter the drive ID of the target drive to create a folder. Example: "t!5x6lueqh2e-xyzphjeeas3ixzfmhidvirnlwdbrtuhpzvxy7tfchska5-crqnd1y" | Text | Required | |
Drive item name | Enter the exact name of the drive name to create a folder. Example: "test_file.txt" | Text | Required | |
Parent ID | Enter the ID of a parent folder if you are creating a sub-folder. Example: "90leq7cbrymigwfdutoihyctxwvazvgks2" | Text | Optional |
Example Request
[
{
"drive_id": "SpSxwPVB52Mh-Xc1JjM7BWayOVRH6Fp2fEc4PRoZA1aIYsuko",
"drive_item_name": "test_file.txt",
"parent_id": "90leq7cbrymigwfdutoihyctxwvazvgks2"
}
]Action: Update a List Item
This action updates the column values and properties for an existing item in a SharePoint list
Note
To perform this action, you must have the Sites.ReadWrite.All permission. No higher privileged permission is available for this action.
Permission type: Delegated (work or school account) or Application. Delegated permissions for personal Microsoft accounts are not supported.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Site ID | Enter the site identifier to specify the SharePoint site context. Example: contoso.sharepoint.com | Text | Required | You can retrieve the site ID using the List Sites action. |
List ID | Enter the list ID or display name to identify the SharePoint list that contains the item you want to update. | Text | Required | |
Item ID | Enter the list item ID to identify the specific item you want to update. | Text | Required | |
Fields | Enter the column names and their corresponding values to update the item. Example: 'Title': 'Widget', 'Color': 'Purple' | Key Value | Required |
Action: Generic Action
This is a generic action used to make requests to any Microsoft SharePoint endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. | Text | Required | Allowed value: GET, PUT, POST, DELETE |
Endpoint | Enter the endpoint to make the request to. Example: /groups | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional | Allowed keys: headers, payload_data, custom_output, download, filename, files, retry_wait, retry_count, and response_type |
Changelog
The following table shows the changelog for each app version:
Version | Changes |
|---|---|
v1.1.0 | Introduced Get List Metadata, Create List, Get List Items, Create Item in a List, Update a List Item, Delete Item from List, Generic Action, and List Operations on a List actions. |