OneNote Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium OneNote connector.

OneNote is Microsoft’s digital note-taking app for organizing ideas, notes, and collaborative content.

This topic describes how to authenticate to OneNote and configure any necessary connection properties in the OneNote connection connector.

Prerequisites

Before You Connect

Microsoft OneNote provides OAuth 2.0-based authentication via both Azure AD and Azure Service Principal.

  • For Azure AD authentication, set AuthScheme to AzureAD.

  • For Azure Service Principal authentication, set AuthScheme to AzureServicePrincipal.

Azure Service Principal

To use Azure Service Principal authentication, you must set up the ability to assign a role to the authentication application. To do this, create a custom OAuth AD application.

Procedure to create a custom OAuth AD application

  1. Log in to https://portal.azure.com.

  2. In the left-hand navigation pane, select Azure Active Directory, then applicationRegistrations.

  3. Click New registration.

  4. Enter a name for the application.

  5. Select the desired tenant setup: single- or multi-tenant, and public or private use.

  6. Set the redirect url to http://localhost:33333 OR specify a different port and set CallbackURL to the exact reply URL you defined.

  7. Click Register to register the new application. This opens an application management screen.

Note the value in Application (client) ID as the OAuthClientId and the Directory (tenant) ID as the AzureTenant.

  1. Navigate to Certificates & Secrets and define the application authentication type. There are two types of authentication available: certificate (recommended) or client secret.

  • For certificate authentication: In Certificates & Secrets, select Upload certificate, then upload the certificate from your local machine.

  • For creating a new client secret: In Certificates & Secrets, select New Client Secret for the application and specify its duration. After the client secret is saved, Microsoft OneNote displays the key value. Copy this value, as it is displayed only once. This value becomes the OAuthClientSecret.

  1. Select API Permissions > Add > Delegated permissions.

  2. Select the Microsoft Graph API, and the following delegated permissions allow access to the full functionality of the connector:

  • Read and write all Notebooks, Sections, SectionGroups and Pages.

  • Read all users.

  • Read all groups.

  1. Save your changes.

  2. If you have specified the use of permissions that require admin consent (such as the Application Permissions), you can grant them from the current tenant on the API Permissions page.

Connection Configuration

Each connection property available in the OneNote connector is explained below.

Connection Name

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Auth Scheme

The type of authentication to use when connecting to Microsoft OneNote.

Possible Values:

  • AzureAD: Set this to perform Azure Active Directory OAuth authentication.

  • AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Client Secret.

Client ID

The client Id assigned when you register your application with an OAuth authorization server.

Client Secret

The client secret assigned when you register your application with an OAuth authorization server.

Access Token

The access token for connecting using OAuth.

Refresh Token

The OAuth refresh token for the corresponding OAuth access token.

Grant Type

The grant type for the OAuth flow.

The following options are available:

  • CODE

  • CLIENT

Azure Tenant

The Microsoft Online tenant being used to access data. If not specified, your default tenant is used.

For instance, contoso.onmicrosoft.com.

Alternatively, specify the tenant Id. This value is the directory Id in the Azure Portal > Azure Active Directory > Properties.

Azure Environment

The Azure Environment to use when establishing a connection.

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment.

The available values are: GLOBAL, CHINA, USGOVT, and USGOVTDOD.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.

If you have any feedback on Gathr documentation, please email us!

← Odoo Incremental Configuration
OneNote Ingestion Source →