Skip to main content

Customer Setup SharePoint

This guide explains what you, as the customer, need to provide to enable the integration between your SharePoint and our platform.


1. Prerequisites​

Before proceeding, ensure you have the following:

  • Admin access to your SharePoint instance.
  • Access to your organization's Azure portal to retrieve the Tenant ID.

2. Retrieve SharePoint Base URL​

Steps to Find the Base URL​

  1. Log in to your organization's Office 365 suite.
  2. From the nine-tile menu, open the SharePoint App.

Office 365 nine-tile menu with the SharePoint app highlighted

  1. Copy the Base URL of your SharePoint instance.

SharePoint site showing the Base URL in the browser address bar


3. Retrieve Microsoft Tenant ID​

Steps to Find the Tenant ID​

  1. Log in to your organization's Azure portal at Azure Portal.
  2. Search for Tenant Properties in the search bar.
  3. Copy the Tenant ID from the Tenant Properties page.

Azure Portal Tenant Properties page showing the Tenant ID


4. Choose Access Mode​

Our SharePoint integration supports two access modes. Choose the one that best fits your organization's security requirements:

ModePermissionDescriptionBest For
Sites.ReadAll (Default)Broad accessAllows the integration to search and access all SharePoint sites in your tenant.Organizations that want full access across all sites without additional configuration.
ListItems.SelectedOperations.Selected(Selected Folder)Restricted access of Folder LevelAllows the integration to access only specific SharePoint Folders or Files that you explicitly grant permission to.Organizations with strict security policies or compliance requirements.

Sites.ReadAll (Default)​

  • No additional setup required after admin consent.
  • The integration can search and retrieve content from any site in your tenant.

How to use this mode:

  • Leave the Selected Folder checkbox unchecked in the UI.
  • Proceed with admin consent.
  • You will see a consent screen to grant permissions to our application.

Admin consent screen requesting SharePoint permissions

Admin consent screen permission details

Selected Folder (Restricted Access)​

If you want restricted access at the folder level, select Selected Folder by checking the checkbox in the UI before proceeding with admin consent.

Selected Folder checkbox in the integration UI

Important: If you select this option, you will see a different consent screen for folder-level permissions, and you must complete the additional steps below after admin consent.

Admin consent screen requesting SharePoint permissions

Folder-level consent screen permission details

After that, additional steps are required following admin consent.

Step 1: Sign in to Graph Explorer​

  1. Navigate to Microsoft Graph Explorer.
  2. Click on your profile icon at the top of the page.
  3. Sign in with your SharePoint Administrator account.

Microsoft Graph Explorer sign-in screen

Step 2: Grant Yourself Full Control Permission​

To grant site access to our application, you first need to give yourself the necessary permissions:

  1. Click on your profile icon and select Consent to permissions.

  2. In the Permissions tab, search for Sites.

  3. Select Sites.FullControl.All and provide consent.

    Note: This permission is only for yourself to enable you to grant access to our application in the next steps.

Consent to permissions dialog in Graph Explorer

Sites.FullControl.All permission selected and consented

Step 3: Retrieve the Site ID​

You need to obtain the Site ID for each SharePoint site you want to grant access to.

  1. In Graph Explorer, identify the site you want to grant permission to and note its Site Name.

    Example: If your site URL is <https://y5x53.sharepoint.com/sites/Support-Testing-fdsf,> the site name is Support-Testing-fdsf.

Graph Explorer request to look up a SharePoint site by name

  1. In Graph Explorer, enter the following GET request in the URL field:
https://graph.microsoft.com/v1.0/sites/{hostName}:/sites/{SiteName}

Example:

https://graph.microsoft.com/v1.0/sites/y5x53.sharepoint.com:/sites/Support-Testing-fdsf
  1. Click Run query.
  2. From the response, copy the id field value. You will need this Site ID for the next step.

Graph Explorer response with the Site ID field

Step 4: Retrieve the Drive ID​

Step 4: Retrieve the Drive ID​

  1. In Graph Explorer, enter the following GET request:
https://graph.microsoft.com/v1.0/sites/{site-id}/drives
  1. Click Run query.
  2. From the response, copy the id field from the first drive in the value array.

Graph Explorer response with the Drive ID field


Step 5: Retrieve the Folder ID​

Get the folder ID for the specific folder you want to grant access to:

  1. In Graph Explorer, enter the following GET request:
https://graph.microsoft.com/v1.0/drives/{drive-id}/root:/{folder-path}
https://graph.microsoft.com/v1.0/drives/b!abc123/root:/MaxCorp
  1. Click Run query.
  2. From the response, copy the id field value. This is the Folder ID.

Graph Explorer response with the Folder ID field


Step 6: Receive Application Client ID​

The delivery team will provide you with the Application (Client) ID of our Azure AD application.


Step 7: Grant Folder Access to the Application​

You must grant our application access to each specific folder using Microsoft Graph Explorer:

  1. In Graph Explorer, change the request method to POST.
  2. Enter the following URL:
https://graph.microsoft.com/v1.0/drives/{drive-id}/items/{folder-id}/permissions
  1. In the Request body section, paste the following JSON:
{
"roles": ["read"],
"grantedToV2": {
"application": {
"id": "<Application-Client-ID>",
"displayName": "CM Marketplace SharePoint Integration"
}
}
}
  1. Make the following replacements:
    • Replace {drive-id} with the Drive ID you retrieved in Step 4
    • Replace {folder-id} with the Folder ID you retrieved in Step 5
    • Replace <Application-Client-ID> with the Client ID provided by the delivery team
  2. Click Run query to execute the request.
  3. Repeat Steps 3-7 for each folder you want the integration to access.

Example: Granting Access to Multiple Folders​

If you want to grant access to folders in multiple sites:

SiteFolderAccess
Max CorpPersonnel infoNO ACCESS
Max CorpFinancial infoNO ACCESS
Max CorpHALO Knowledge baseACCESS
Max WorksOther foldersNO ACCESS
Max WorksHALO CenterACCESS

For the above scenario, you would:

  1. Grant folder permission for "HALO Knowledge base" in Max Corp site
  2. Grant folder permission for "HALO Center" in Max Works site

Below is the video for Reference:


Share Details with the Delivery Team​

Once you have completed the setup, share the following details with the delivery team:

InformationRequiredDescription
Base URLYesYour SharePoint base URL (e.g., https://yourdomain.sharepoint.com)
Tenant IDYesYour Azure AD Tenant ID
Access ModeYesChoose: Sites.ReadAll (default) or Selected Folder (restricted)