Audience
This guide is for SharePoint Folder administrators who want to configure BRYTER integration with SharePoint Folder.
Please note that this is a premium feature which needs to be enabled by your dedicated Customer Success Manager. For further information, please reach out to your BRYTER Customer Success Manager or support@bryter.io. Additional pricing may apply.
Before you start
Before using either the SharePoint List or SharePoint Folder integration, you must first register a SharePoint app and grant the app permission to access to the SharePoint API. This requires SharePoint administrator permissions that BRYTER does not have. Contact your organization’s SharePoint administrator before proceeding.
Your SharePoint administrator should follow the instructions in: Granting access using SharePoint App-Only (Microsoft), using the following information:
- Title: BRYTER
- App Domain: bryter.io
- Redirect URI: https://app.bryter.io/admin/auth/callback
<AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="Write"/>
</AppPermissionRequests>
- Permission XML (Write permission instead of FullControl)
Known issues and limitations
This integration does not currently support personal Sharepoint sites, i.e. accessing a user’s OneDrive, with a URL like https://youorganisation-my/... with -my suffix in the host.
The Admin Console
This image illustrates the Admin Console’s Integrations page, where you can configure integrations installed in the Catalog.
Parameters
Name |
Description |
Example value |
sharepoint-instance | The base URL of the SharePoint instance, without the "http://" part | bryter.sharepoint.com |
sharepoint-site | The SharePoint Site that the List belongs to. You should take the value as it appears in the URL as whitespace in the site name is removed in the URL. So when a site appears as A Test Site on the website you should use ATestSite or atestsite as a value for sharepoint-site. | custom-integrations-test |
sharepoint-root-folder | Sharepoint root folder where uploaded documents will be stored. It is safest to use a folder whose name contains only alpha-numerical characters. Other characters like – may be present in the name of a folder shown on the website but must not be included in the sharepoint-root-folder configuration value. So Test-Folder will become TestFolder. Also note the special case of the Documents folder which must be configured as Shared Documents. Generally, the value of the sharepoint-root-folder parameter should be taken from the url and not from the name displayed on the website. Note, that this exactly opposite to the way the parameter sharepoint-list-name for the Sharepoint List integration needs to be set. | Shared Documents |
Secrets
Name |
Description |
Example value |
client-id | An authorized client ID | 3740b26c-292b-4d9b-9b09-a59da251d18d |
client-secret | An authorized client secret | FKb0KZPyu6vTOfh2QFeWOHaf03kWlX1JI3RyCzW4qmp= |
Troubleshooting
Sharepoint integration error messages |
Cause |
500: Initialization error: Service Error: API (*.sharepoint.com) operation failure: 503 / | sharepoint-instance not correct |
500: Configuration error: There was an error configuring the SharePoint * integration : 404 Not Found - Not found | Sitename wrong, Trying to access a site the app does not have xml permissions to do so |
401 Unauthorized - API (*.sharepoint.com) operation not allowed: 403 / {"error":{"code":"-2147024891, System.UnauthorizedAccessException","message":{"lang":"en-US","value":"Access is denied. (Exception from HRESULT: 0x80070005 (E_ACCESSDENIED))"}}} | App does not have any xml access |
Sharepoint Folder integration error messages |
Cause |
Folder Upload will return : 401 API (.sharepoint.com) operation not allowed Folder Download will return: 400 Input error: Not found List Files will work but not return anything |
Folder name wrong, No access granted to the specified folder or list |