@devries-cameron20 / composio Mirror · read-only
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 06:00 UTC

next
md 85 lines 6.59 KB
Rendered Raw
1 ## How do I set up custom OAuth credentials for OneNote?
2
3 Use your own Microsoft Entra ID app registration when you want the Microsoft consent screen to show your app's name and you want to control which permissions OneNote requests.
4
5 ### Create the Microsoft Entra app
6
7 1. Sign in to the [Azure portal](https://portal.azure.com/), open **App registrations**, and click **New registration**.
8
9 ![Azure App registrations page with the New registration button](/images/toolkits/onenote/app-registrations.webp)
10
11 2. Enter a **Name**. Under **Supported account types**, choose **Accounts in any organizational directory and personal Microsoft accounts** (shown as **Any Entra ID Tenant + Personal Microsoft accounts**) if you want to connect both work or school and personal accounts. Choose a single-tenant or multitenant organizational option if you only connect work or school accounts.
12 3. Under **Redirect URI**, select the **Web** platform, enter `https://backend.composio.dev/api/v1/auth-apps/add`, and click **Register**.
13 4. On the app's **Overview** page, copy the **Application (client) ID**.
14
15 ![Entra app Overview page with the client, object and tenant IDs censored](/images/toolkits/onenote/app-overview.webp)
16
17 5. Open **Certificates & secrets** and click **New client secret**. Add a description, choose an expiry that fits your rotation policy (for example, 180 days), and click **Add**. Rotate the secret before it expires.
18
19 ![Certificates & secrets page with the New client secret button](/images/toolkits/onenote/certificates-and-secrets.webp)
20
21 ![Add a client secret panel with a description and the 180-day expiry](/images/toolkits/onenote/add-client-secret.webp)
22
23 6. Copy the secret **Value** right away. Use the **Value**, not the **Secret ID**. Azure shows the full value only once; if you lose it, create a new secret.
24
25 ![Client secrets tab with the Value and Secret ID columns](/images/toolkits/onenote/client-secrets-list.webp)
26
27 7. Open **API permissions**, click **Add a permission**, select **Microsoft Graph**, and choose **Delegated permissions** so the app acts as the signed-in user. Add `Notes.ReadWrite` and `offline_access` (refresh tokens), plus any other OneNote scopes you'll select in Composio. `User.Read` is already listed by default, then click **Add permissions**.
28
29 ![API permissions page with the Add a permission button](/images/toolkits/onenote/api-permissions.webp)
30
31 ![Request API permissions panel with Microsoft Graph under Microsoft APIs](/images/toolkits/onenote/microsoft-graph-api.webp)
32
33 ![Microsoft Graph permission type choice with Delegated permissions](/images/toolkits/onenote/delegated-permissions.webp)
34
35 ![Microsoft Graph delegated permissions with Notes.ReadWrite selected](/images/toolkits/onenote/notes-readwrite-permission.webp)
36
37 ![Microsoft Graph delegated permissions with offline_access selected](/images/toolkits/onenote/offline-access-permission.webp)
38
39 ![Configured permissions list with Notes.ReadWrite, offline_access and User.Read](/images/toolkits/onenote/configured-permissions.webp)
40
41 8. If your tenant restricts user consent, have a tenant admin click **Grant admin consent for** your tenant on the **API permissions** page. Adding a permission to the app registration doesn't grant consent by itself.
42
43 The redirect URI you register must exactly match the `oauth_redirect_uri` field in your Composio auth config (default `https://backend.composio.dev/api/v1/auth-apps/add`).
44
45 ### Create the auth config in Composio
46
47 1. In the Composio dashboard, go to **Auth Configs**, click **Create**, and select **OneNote**. Enter a config name and click **Next**.
48
49 ![Composio Auth Configs page with the Create button](/images/toolkits/onenote/composio-auth-configs.webp)
50
51 ![Create Auth Config dialog with Microsoft OneNote selected](/images/toolkits/onenote/composio-toolkit-picker.webp)
52
53 ![Auth config name field with the Next button](/images/toolkits/onenote/composio-config-name.webp)
54
55 2. Select **OAuth 2.0** and **Your Own Credentials**. Paste the Application (client) ID into **Client id** and the secret value into **Client secret**. Leave **Redirect URI** as shown. Keep **Microsoft cloud environment** (`microsoft_cloud`) set to `global` for commercial Microsoft 365, or set `gcc_high` for Microsoft 365 US Government GCC High. The app registration must live in that cloud.
56
57 ![Composio OAuth 2.0 form with empty Client id and Client secret fields and the v1 redirect URI](/images/toolkits/onenote/composio-oauth-credentials.webp)
58
59 3. Under **Scopes**, select the same permissions you added in Azure, then click **Create Auth Config**.
60 4. Open the auth config and click **Connect Account**. Sign in with the Microsoft account you want to connect and click **Accept**. Leave **Consent on behalf of your organization** unchecked unless you're an admin granting tenant-wide consent. An **unverified** label is expected for a custom app without a verified publisher.
61
62 ![OneNote auth config panel with the Connect Account button](/images/toolkits/onenote/composio-connect-account.webp)
63
64 ![Microsoft Pick an account page with the account censored](/images/toolkits/onenote/microsoft-account-picker.webp)
65
66 ![Microsoft consent prompt for OneNote notebook access with organization consent unchecked](/images/toolkits/onenote/microsoft-consent.webp)
67
68 5. Back on the auth config's **Connected Accounts** tab, confirm the account shows **Active**. The **Enabled** label at the top of the page describes the auth config, not the account.
69
70 ![Connected Accounts tab with the OneNote account showing Active](/images/toolkits/onenote/connected-account-active.webp)
71
72 For the general flow, see [custom auth configs](/docs/auth-configuration/custom-auth-configs).
73
74 ### Scopes
75
76 The default auth config requests `Notes.Read`, `Notes.ReadWrite`, `Notes.Create`, `Notes.Read.All`, `Notes.ReadWrite.All`, `Sites.Read.All`, `Team.ReadBasic.All`, `offline_access`, and `User.Read`. If your agent only reads notes, `Notes.Read` is enough. OneNote calls go through Microsoft Graph at `https://graph.microsoft.com/v1.0/me/onenote/`.
77
78 ### Restrict sign-in to one tenant
79
80 The connection's tenant field (`issuer`) defaults to `common`. To restrict sign-in to one tenant, set it to your **Directory (tenant) ID** from the app's **Overview** page or a verified tenant domain.
81
82 ### Revoke access
83
84 - In Composio, delete the connected account from the auth config, or disable the auth config.
85 - In Microsoft, work or school users remove the app at [myapps.microsoft.com](https://myapps.microsoft.com/), and personal account users remove it at [account.microsoft.com/privacy/app-access](https://account.microsoft.com/privacy/app-access). This revokes OneNote's access.