- Cyware Orchestrate
- Integrations
- IT Services
- Microsoft SharePoint
Microsoft SharePoint
App Vendor: Microsoft
App Category: IT Services
Connector Version: 1.0.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 |
|---|---|
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. |
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 the child items available in a drive. |
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. |
Download File | This action downloads a file. |
Get Drive Item Details | This action retrieves the details about a given drive item. |
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. |
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. |
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. |
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: 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 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: 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: 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"
}
]