- 30 Sep 2024
- 2 Minutes To Read
-
Print
-
DarkLight
-
PDF
Generate ClientID and SecretKey for SharePoint Integration
- Updated On 30 Sep 2024
- 2 Minutes To Read
-
Print
-
DarkLight
-
PDF
Generating Client ID and Secret Key for SharePoint Integration is a two-step process.
Step 1: Register the Add-In
Step 2: Grant permissions for the Add-in
Step 1 : Register the Add-In
- Log in with an admin account on the parent site, and then go to the following URL,
https://[sitename].sharepoint.com/_layouts/15/appregnew.aspx
-
For sites:
Replace the [sitename] in the above URL with your site name.
For example, if your SharePoint site is https://abcd.sharepoint.com, then replace thewith abcd. -
For subsites: To add subsites, append your subsite name to the site URL.
For example, if your subsite URL is of the form: https://abcd.sharepoint.com/sites/subsite1, then the above URL is https://abcd.sharepoint.com/sites/subsite1/_layouts/15/appregnew.aspx
- Enter the following information on the page that is displayed when you first visit the URL.
- In the App Information section, click the Generate button next to the Client Id and Client Secret text boxes to generate the respective values.
- In the Title textbox, enter the Add-In.
- In the App Domain text box, enter the localhost.
- In the Redirect URL text box, enter https://localhost
- Click Create.
The Add-in is registered, and the following message is displayed.
Make a note of the above information and share the Client ID and Client Secret with a Whatfix representative.
Step 2: Grant Permissions for the Add-in
Once the Add-In is registered, the next step is to set the permissions for that add-in to access the SharePoint data.
Whatfix sets the read permission level to the web scope to be able to read the web information.
- Go to the following URL in the browser.
This redirects to the Grant permission page.
https://<sitename>.sharepoint.com/_layouts/15/appinv.aspx
-
For sites: Replace the
<sitename>
in the above URL with your site name.
For example, if your SharePoint site is https://abcd.sharepoint.com, then replace the<sitename>
with abcd. -
For subsites: To add subsites, append your subsite name to the site URL.
For example, if your subsite URL is of the form: https://abcd.sharepoint.com/sites/subsite1, then the above URL is https://abcd.sharepoint.com/sites/subsite1/_layouts/15/appinv.aspx
- Enter the Client ID (which you have generated earlier) in the App Id textbox, and click the Lookup button.
This populates the value to other text boxes in Title, App Domain, and Redirect URL.
- In the App's Permission Request XML section, enter the following permission request in XML format.
<AppPermissionRequests
AllowAppOnlyPolicy="true"><AppPermissionRequest
Scope="http://sharepoint/content/sitecollection/web"
Right="Read" /></AppPermissionRequests>
The permissions granted are Read-Only, so our API cannot update or delete any data from your SharePoint site.
- Click Create.
- Click Trust It to trust the add-in to read items from your website.