About

Microsoft SharePoint

A BDK Book containing automation procedures for Microsoft SharePoint.

Overview

The Microsoft SharePoint Book (BDK) allows users to interact with and manage SharePoint sites, lists, document libraries, and files via the Microsoft Graph API. Users can automate tasks such as reading list items, uploading files to document libraries, and navigating across multiple sites.

Prerequisites

Learning the Microsoft SharePoint Book (BDK)

You need to learn the Sharepoint bdk Book in your agent:

1

Navigate to Books

In the left navigation bar, click on Books.

2

Add a Book

In the Books page, click on + New Book.

3

Search for the Book

Search for the Book's name. Click on the version tagged with bdk.

You will be prompted to provide the connectivity details if configuration is required.

4

Finalize

Click Add to finish adding your Book.

After learning a Book, publish your agent and create a new Playground. Previously created Playgrounds will not be able to recognize the new Book.

Connectivity

Connecting to the Microsoft SharePoint BDK Book requires the following credentials:

  • Client ID (Application ID)

  • Client Secret (Application Password)

  • Tenant ID (Directory ID)

Obtaining SharePoint Credentials

Credentials are generated by registering an app in Microsoft Entra ID (formerly Azure AD), which gives the SharePoint BDK Book permission to access your data.

1

Sign in to the Azure Portal

Navigate to portal.azure.com with an account that has permissions to manage applications. From the main dashboard, select Microsoft Entra ID (under Azure Services).

2

Create a New App Registration

  1. Click on + Add and select App registration.

  2. Enter a Name for the app. For example: "Kognitos SharePoint Book Integration".

  3. Under Supported account types, choose "Accounts in this organizational directory only".

  4. Leave the Redirect URI field blank.

  5. Click on Register to create the app.

3

Capture the Client ID and Tenant ID

After creating the app, you'll land on its Overview page. Copy the Application (client) ID and Directory (tenant) ID from this page.

4

Generate a Client Secret

  1. Click on Manage on the left.

  2. Select Certificates and Secrets from the dropdown menu.

  3. Under Client Secrets, click on + New client secret.

  4. Enter a description for the secret and choose an expiration period.

  5. Click Add. Copy the Secret's Value as your Client Secret.

Client secret values cannot be viewed except immediately after creation. Be sure to save the secret when it is created before leaving the page!

5

Assign API Permissions

  1. Click on Manage on the left.

  2. Select Certificates and Secrets from the dropdown menu.

  3. Click on + Add a permission, then select Microsoft Graph.

  4. Choose Application permissions, as the Book will access SharePoint without a signed-in user.

  5. Search for and select the following permissions:

    • Sites.Read.All

    • Sites.FullControl.All

    • Sites.Manage.All

    • Sites.ReadWrite.All

For more restricted access, you can use the Sites.Selected permission, but this requires additional configuration to grant access to specific SharePoint sites.

  1. Click on Add permissions.

6

Grant Admin Consent

On the API permissions screen, click on Grant admin consent for [Your Organization Name] button, then select Yes. This authorizes the application to use the permissions you assigned across your organization.

Last updated

Was this helpful?