SharePoint

Setup Guide

You can find your SharePoint application credentials by visiting your Microsoft Azure Portal.

You’ll need the following information to set up your SharePoint app with Paragon Connect:

• Client ID
• Client Secret
• Scopes Requested

​

Prerequisites

• A Microsoft Azure account

​

Add the Redirect URL to your SharePoint app

Paragon provides a redirect URL to send information to your app. To add the redirect URL to your SharePoint app:

1. Copy the link under “Redirect URL” in your integration settings in Paragon. The Redirect URL is:

https://passport.useparagon.com/oauth

2. Log in to the Microsoft Azure Portal using your Microsoft account.

3. Navigate to All Services > App Registrations and select your application.

4. Select Authentication from the sidebar.

5. Under Platform configurations, press the “Add a platform” button.

6. Select the Web platform.

7. Paste the Redirect URL from Step 1 under Redirect URIs.

8. Press the Save button at the top of the page.

​

Generate a Client Secret

Since SharePoint does not automatically provide you with a Client Secret for your application, we’ll need to make one. To get your Client Secret:

1. Navigate to Manage > Certificates & secrets in the sidebar.

2. Under Client Secrets, press the + New client secret button.

3. Name your client credentials and select an expiry that works best for your application. Press Add to create your credentials.

4. Copy the displayed Client Secret under the Value column.

​

Enable Multi-tenancy to your SharePoint app

To allow Microsoft users from outside of your organization to connect to your SharePoint application, you must specify this as an option within the SharePoint application registration.

1. Log in to the Microsoft Azure Portal using your Microsoft account.

2. Navigate to All Services > App Registrations and select your application.

3. Select Authentication from the sidebar.

4. Under Supported account types, press the “Accounts in any organizational directory” option.

5. Click Save.

​

Add your SharePoint app to Paragon

1. Select SharePoint from the Integrations Catalog.

2. Under Integrations > Connected Integrations > SharePoint > App Configuration > Configure, fill out your credentials from the end of Step 1 and Step 2 in their respective sections:

• Client ID: Found under Essentials > Application (client) ID on your Microsoft Azure Portal app page.
• Client Secret: Found at the end of Step 2.
• Permissions: Select the scopes you’ve requested for your application. For a list of recommended scopes, please view this integration within your Paragon dashboard. View dashboard.

Press the purple “Save Changes” button to save your credentials.

​

Connecting to SharePoint

Once your users have connected their SharePoint account, you can use the Paragon SDK to access the SharePoint API on behalf of connected users.

See the SharePoint REST API documentation for their full API reference.

Any SharePoint API endpoints can be accessed with the Paragon SDK as shown in this example.

// You can find your project ID in the Overview tab of any Integration

// Authenticate the user
paragon.authenticate(<ProjectId>, <UserToken>);

// Get organization’s default site
await paragon.request("sharepoint", "/sites/root", { 
  method: "GET",
});


// Get list under a site
await paragon.request("sharepoint", "/sites/{site-id}/lists", { 
  method: "GET",
});

// Create task in list
await paragon.request("sharepoint", "sites/{site-id}/lists/{list-id}/items", { 
  method: "POST",
  body: {
    "fields": {
      "Title": "Widget",
      "Color": "Purple",
      "Weight": 32
    }
}
});

​

Building SharePoint workflows

Once your SharePoint account is connected, you can add steps to perform the following actions:

• Create Item
• Update Item
• Get Item by ID
• Get Items in a List
• Delete Item
• Create List
• Get List by ID
• Get Lists
• Create List column
• Get List columns

When creating messages in SharePoint, you can reference data from previous steps by typing {{ to invoke the variable menu.

​

Using Webhook Triggers

Webhook triggers can be used to run workflows based on events in your users’ Sharepoint account. For example, you might want to trigger a workflow whenever new items are created in Sharepoint to sync your users’ Sharepoint items to your application in real-time.

You can find the full list of Webhook Triggers for Sharepoint below:

• Item Created
• Item Updated
• Page Modified
• File Deleted

​

Using the SharePoint File Picker

You can allow your user to select files from their SharePoint account in your app with the Paragon SDK.

Showing the File Picker

Use the Paragon SDK in your frontend application to show the File Picker in your app.

The SDK provides an ExternalFilePicker class to load SharePoint’s JavaScript into your page and authenticate with your user’s connected SharePoint account.

let picker = new paragon.ExternalFilePicker("sharepoint", {
    onFileSelect: (files) => {
        // Handle file selection
    }
});

// Loads external dependencies and user's access token
await picker.init();

// Open the File Picker
picker.open();

You can configure the File Picker to listen for additional callbacks or to restrict allowed file types. Learn more about configuring File Picker options in the SDK Reference.

​

Downloading the Selected File

The SharePoint File Picker callback will return a Response object describing the user’s file picker interaction including an array of any files selected. Using this array of fileIds, you can use the Proxy API to perform an authenticated proxy requests to download the files.

await paragon.request('sharepoint', '/_api/web/GetFileById(<fileID>)/$value', {
	method: 'GET'
});