Connectors

Create an App in SharePoint and Connect via OAuth

The SharePoint connector has now been re-worked to make connecting easier. Please see the new documentation for the updated process.

This has now been superseded by creating an App in Azure AD as it is easier to manage when the Client Secret expires. However if you cannot access your organizations Azure AD then this will be the best method to use.

The summary of the flow you need to follow

  1. Create the App in SharePoint at the following link:https://{yourdoman}.sharepoint.com/_layouts/15/appregnew.aspx
  2. Give the App permission in SharePoint at this link: https://{yourdomain}.sharepoint.com/_layouts/15/appinv.aspx
  3. Connect in Data Sync using the credentials you gathered in the first step.

1. Create the App in SharePoint

You will need to be a Site Collection Administrator to do this. If you do not have permission please contact your Site Administrator to create this for you.

Go to your SharePoint site and navigate to the application page. This can be found at the following link:https://{yourdoman}.sharepoint.com/_layouts/15/appregnew.aspx

Generate a Client ID and Client Secret by clicking onto the Generate buttons. Then enter in a title for your App and enter an app domain and redirect URI. Now click Create to create the app.

Register App

When you have clicked create you will be given a confirmation page with all of your app details. Make a note of these as we will need to use them again later.

2. Set Permission Level

Now we need to set the permission levels for the app, do this by navigating to the application page at: https://{yourdomain}.sharepoint.com/_layouts/15/appinv.aspx

Enter in the Client ID you generated earlier into the App ID field and lookup the Application. This will enter in the details you entered earlier into the other fields.

We now need to add the XML permission statement to give full control to the application. The XML we use to do this is:

<AppPermissionRequests AllowAppOnlyPolicy="true">
	<AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" />
</AppPermissionRequests>

Define App Permissions

Once you are done click Create to set the permissions.

To learn more about these permissions please see the Microsoft website here .

3. Connect in Data Sync

To connect in Data Sync open the connection window and go to SharePoint Online provider. Enter in the URL to your base url of your SharePoint site i.e. http://<sharepointurl>/<site1>/<site2> and click on the ellipsis (...) in the OAuth2 field to open the OAuth credentials window.

SharePoint Connection

Enter in your Client ID and Client Secret and click OK to save the credentials.

OAuth

Choose the list or library you wish to connect to from the ListName dropdown menu and then connect by clicking Connect & Create Library Connection to save the connection to your connection library. Otherwise simply click Connect.

Save to Connection Library

You're now connected to your SharePoint site and can configure your Data Sync project as you need to.