@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 83 lines 7.22 KB
Rendered Raw
1 ## How do I set up custom OAuth credentials for Microsoft Teams?
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 Microsoft Teams 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/shared/5uRKMRjmfWRjXAIPnkdZ8jDIX4.webp)
10
11 2. Enter a **Name**. Under **Supported account types**, choose an organizational option: **Accounts in this organizational directory only** (single tenant) or **Accounts in any organizational directory** (multitenant). Teams connections require a work or school account; a personal Microsoft account can't connect.
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/shared/m3IgMHHfNa8gv1av1yK5u8y47Pg.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/shared/nDFU25pH9BfPuJzceax2NoFVzIw.webp)
20
21 ![Add a client secret panel with a description and the 180-day expiry](/images/toolkits/shared/Ea7qmGPRdmtbyoxbuXiKG7bct1Q.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 list with the Value and Secret ID censored](/images/toolkits/shared/wl7JybvARU75U43YShwhxk1Pgxk.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 the delegated permissions that match the scopes you'll select in Composio (see **Scopes** below), then click **Add permissions**.
28
29 ![API permissions page with the Add a permission button](/images/toolkits/shared/BOmH98f2n8W8w0fbYP6WUJ1mFII.webp)
30
31 ![Request API permissions panel with Microsoft Graph selected](/images/toolkits/shared/J4V5TpgIBuXDk4prikxhduGZQxM.webp)
32
33 ![Microsoft Graph permission type choice with Delegated permissions](/images/toolkits/shared/9cVvSnHVsreVO2KBW80wvMy50Bo.webp)
34
35 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.
36
37 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`).
38
39 ### Create the auth config in Composio
40
41 1. In the Composio dashboard, go to **Auth Configs**, click **Create**, and select **Microsoft Teams**. Enter a config name and click **Next**.
42
43 ![Composio Auth Configs page with the Create button](/images/toolkits/shared/10qkqAzadRISRYZhaXXdhXA.webp)
44
45 ![Create Auth Config dialog with Microsoft Teams selected](/images/toolkits/microsoft_teams/composio-toolkit-picker.webp)
46
47 ![Auth config name field with the Next button](/images/toolkits/microsoft_teams/composio-config-name.webp)
48
49 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.
50
51 ![Composio auth config form with OAuth 2.0 and Your Own Credentials selected](/images/toolkits/microsoft_teams/composio-own-credentials.webp)
52
53 ![Composio auth config with censored credentials, the v1 redirect URI and Microsoft cloud environment set to global](/images/toolkits/microsoft_teams/composio-credentials-cloud.webp)
54
55 3. Under **Scopes**, select the same permissions you added in Azure, then click **Create Auth Config**.
56
57 ![Composio scopes list with Chat.ReadWrite, offline_access and User.Read selected](/images/toolkits/microsoft_teams/composio-scopes.webp)
58
59 4. Open the auth config and click **Connect Account**. Sign in with a work or school account, check that the consent prompt shows your app's name, 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.
60
61 ![Microsoft Teams auth config panel with the Connect Account button](/images/toolkits/microsoft_teams/composio-connect-account.webp)
62
63 ![Microsoft Pick an account page with the accounts censored](/images/toolkits/microsoft_teams/microsoft-account-picker.webp)
64
65 ![Microsoft consent prompt for the unverified custom app with organization consent unchecked](/images/toolkits/microsoft_teams/microsoft-consent.webp)
66
67 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.
68
69 ![Auth config Accounts tab with the Microsoft Teams account showing Active](/images/toolkits/microsoft_teams/connected-account-active.webp)
70
71 For the general flow, see [custom auth configs](/docs/auth-configuration/custom-auth-configs).
72
73 ### Scopes
74
75 The default auth config requests `Channel.Create`, `Channel.ReadBasic.All`, `ChannelMessage.Read.All`, `ChannelMessage.ReadWrite`, `ChannelMessage.Send`, `ChannelSettings.ReadWrite.All`, `Chat.Create`, `Chat.Read`, `Chat.ReadBasic`, `Chat.ReadWrite`, `Chat.ReadWrite.All`, `ChatMessage.Read`, `ChatMessage.Send`, `Directory.ReadWrite.All`, `Group.ReadWrite.All`, `offline_access`, `People.Read.All`, `Presence.ReadWrite`, `Team.Create`, `Team.ReadBasic.All`, `TeamMember.ReadWrite.All`, `TeamsActivity.Read`, `TeamsActivity.Send`, `User.Read`, `OnlineMeetings.ReadWrite`. Several of these, including `Directory.ReadWrite.All`, `Group.ReadWrite.All`, and `ChannelMessage.Read.All`, need admin consent. Request only what your workflow uses: updating chat properties, for example, needs only `Chat.ReadWrite`. See Microsoft's [update chat](https://learn.microsoft.com/en-us/graph/api/chat-patch?view=graph-rest-1.0) reference.
76
77 ### Restrict sign-in to one tenant
78
79 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.
80
81 ### App-only access (client credentials)
82
83 Microsoft Teams also supports an app-only auth mode (`S2S_OAUTH2`) that runs without a signed-in user. It takes the **Client id**, the **Client secret** value, and your Microsoft Entra **tenant ID** (`generic_id`) as a GUID, found under **Microsoft Entra ID** > **Overview** > **Tenant ID**. For this mode, add **Application permissions** instead of delegated permissions on the app registration, and have an admin grant admin consent.