> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/microsoft.md).

# Microsoft

## OAuth app properties

| Property                | Value                                                                                                                                                                                                                                                                                                                                                                                                              |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Multi-tenant**        | **Yes.** When **Supported account types** is set to a multitenant option, users of any Microsoft Entra tenant can connect. Personal Microsoft accounts (OneDrive personal, Outlook.com) work only if the option includes personal accounts.                                                                                                                                                                        |
| **Vendor review**       | **By scope.** No review of the app itself. Users can consent to low-risk permissions. Permissions that need admin consent, or that the customer's consent policy blocks, need a global or application admin of each customer tenant to grant consent. Publisher verification (a verified Microsoft AI Cloud Partner Program account) is optional but many tenants allow user consent only for verified publishers. |
| **Review time**         | Publisher verification takes minutes once the Partner Program account is verified. Admin consent depends on each customer's admin.                                                                                                                                                                                                                                                                                 |
| **Users before review** | No limit.                                                                                                                                                                                                                                                                                                                                                                                                          |
| **App owner**           | Any Microsoft Entra tenant. For publisher verification the app must be registered with a work or school account, and its publisher domain must match a verified domain of the Partner Program account (not `*.onmicrosoft.com`).                                                                                                                                                                                   |
| **Regions**             | One app for the global Microsoft cloud. Publisher verification is not available in national clouds.                                                                                                                                                                                                                                                                                                                |
| **Client secret**       | Expires after at most 24 months; Microsoft recommends less than 12.                                                                                                                                                                                                                                                                                                                                                |
| **Rate limits**         | Per service, mostly per app and tenant or per mailbox. Across all tenants, one app may send at most 130,000 Microsoft Graph requests per 10 seconds.                                                                                                                                                                                                                                                               |
| **Checked**             | 2026-11-13                                                                                                                                                                                                                                                                                                                                                                                                         |

**Limitations**

* The default consent setting of new tenants (*Let Microsoft manage your consent settings*) blocks user consent to `Files.Read.All`, `Files.ReadWrite.All`, `Sites.Read.All`, `Sites.ReadWrite.All`, `Mail.*`, `Calendars.*` and `MailboxSettings.Read`. The OneDrive, SharePoint, Excel, Outlook Mail and Calendar components request these, so in such a tenant an admin has to grant consent before users can connect. `ChannelMessage.Read.All` (Teams) always needs admin consent.
* When the client secret expires, every connected account fails until you add a new secret in the Azure portal and set it in the Backoffice. Note the expiry date.
* A refresh token that is not used for 90 days expires, and an admin can revoke all of a user's tokens or reset their password. The user then connects the account again.
* With `microsoftTenant` (see **2. Allowing Custom Tenant** below) the user signs in to the tenant they enter, not through `common`.

Sources: [Publisher verification](https://learn.microsoft.com/en-us/entra/identity-platform/publisher-verification-overview), [User consent settings](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/configure-user-consent), [App consent policies](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/manage-app-consent-policies), [App credentials](https://learn.microsoft.com/en-us/entra/identity-platform/how-to-add-credentials), [Refresh tokens](https://learn.microsoft.com/en-us/entra/identity-platform/refresh-tokens), [Graph throttling limits](https://learn.microsoft.com/en-us/graph/throttling-limits). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## 1. Register Oauth2 applications

Follow the next link:

{% embed url="<https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade>" %}
Azure portal
{% endembed %}

![+ New registration](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-983c2d140ec465c40c63d24ae5ce611d43dd8f49%2Fmicrosoft-1.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-64b0debd6350f5660b1e316bedd1159e9f50af88%2Fmicrosoft-2.png?alt=media)

#### Redirect URI

The `Redirect URL` should be the URL where Microsoft will redirect the user after they authorize your app. This depends on your environment, usually in the following format: `https://api.ACME.com/auth/microsoft/callback`

The OneDrive file picker needs a specific redirect URI, which is used exclusively for configuring the OneDrive connector. This picker enables users to browse and choose files directly from their OneDrive storage. Use this format for the OneDrive picker redirect URI: \`<https://api.ACME.com/plugins/appmixer/microsoft/onedrive/picker>

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-504663922ecfaacc83382750dd7db2857250cb6a%2Fmicrosoft-3.png?alt=media)

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-3aca636c268343c4eb7d46c09cc1b50912ea0cbd%2Fmicrosoft-4.png?alt=media" alt=""><figcaption><p>/plugins/appmixer/microsoft/onedrive/picker</p></figcaption></figure>

And select both of these options:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-edef30ff4e84eba083a53e782c0241dfccef4ff2%2Fmicrosoft-5.png?alt=media)

And save the changes:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-52694fc77ffbc31c1037407c5dc5d34462f51564%2Fmicrosoft-6.png?alt=media)

The next step is creating *clientId* and *clientSecret*:

![Add new client secret](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-66294e4138f636d878b08561f66eec02e1fe3255%2Fmicrosoft-7.png?alt=media)

Unfortunately, the secret has an expiration, you're going to have to create a new one in 2 years:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-6efef4d929eaddec63a925b415bd743c6bed2e48%2Fmicrosoft-8.png?alt=media)

Use the furthest date possible:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-d37150b70cf00936885729be9807f060021f3a9f%2Fmicrosoft-9.png?alt=media)

You will get a new secret, copy the *Value* into the clipboard:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-663c8f2574b082d37eef899950d145b786f8651b%2Fmicrosoft-10.png?alt=media)

This is the *clientSecret*. The *clientId* is the *Application (client) ID* from the *Overview* page:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-2286009271c09e7182230a087c5c1e198c557c25%2Fmicrosoft-14.png?alt=media)

Both go into the Backoffice, see [Backoffice configuration](#backoffice-configuration).

Then go to the *API permissions* section:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-64f7b33f440de5f48fcfeee4cd0a5fc9e542fe64%2Fmicrosoft-16.png?alt=media)

Choose *Microsoft Graph*:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-3406df0644711b415480e76a4ba8e7acd992ca16%2Fmicrosoft-17.png?alt=media)

Delegated permissions:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-29b5ea46fbf215dc71950b087e7df950b63adc2a%2Fmicrosoft-18.png?alt=media)

Type-in *Files*:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-39844c7454316cbe6381729c0fef3244ee088997%2Fmicrosoft-19.png?alt=media)

And select these two:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-20d149fa19c666990a383a65d304e49e5b40c890%2Fmicrosoft-20.png?alt=media)

Then type-in *offline* and select this permission:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-5c55a39769e5b74bf3c29bffac2bc54ebc544fc1%2Fmicrosoft-21.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-3b8af0d00cf21550446dd17df4b52170c2e50177%2Fmicrosoft-22.png?alt=media)

The final set of permissions:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-8b6b83eaa4a7f18819c76c1ad099dc580e31db7e%2Fmicrosoft-23.png?alt=media)

## 2. Allowing Custom Tenant

To let users sign in to a specific Microsoft Entra tenant, set `microsoftTenant` to `true` in the `appmixer:microsoft` configuration (see [Backoffice configuration](#backoffice-configuration)). This adds a **Tenant** field to the Microsoft connection form.

### Connect with Custom Tenant

1. Return to your flow and locate a Microsoft connector
2. Click **"Connect account"**
3. You should now see a **"Tenant"** field in the connection form

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-806590a65054c928302cabf2ce14c5fcb9ef50a1%2Fmicrosoft-28.png?alt=media)

4. Enter your Tenant ID in the field

### Tenant Value Options

* **Custom Tenant ID**: Enter your organization's specific tenant identifier
* **Default Behavior**: Enter `common` to use Microsoft's default multi-tenant behavior

> **💡 Tip**: If you're unsure about your Tenant ID, you can find it in the Azure Active Directory overview page in the Azure portal.

### Disable Custom Tenant

* Remove `microsoftTenant` from the configuration or set it to `false`.

## Backoffice configuration

Configuration ID: `appmixer:microsoft` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

The Microsoft Calendar, Excel, Mail, OneDrive, SharePoint and Teams modules sign in through the same app and read this one configuration. Microsoft Dynamics 365 CRM has its own configuration, `appmixer:microsoft:dynamics`; see [Microsoft Dynamics 365 CRM](https://docs.appmixer.com/connector-configuration/microsoft-dynamics-365-crm.md#backoffice-configuration).

* `clientId` — the *Application (client) ID* from the *Overview* page of the app registered above (not the *Secret ID*). The OneDrive file picker uses it too. Not needed when Microsoft is authenticated through the Appmixer Auth Hub.
* `clientSecret` — the *Value* of the client secret. It expires (at most 24 months); add a new secret in the Azure portal and update this key before then. Not needed with the Auth Hub.
* `microsoftTenant` — Optional. `true` adds a **Tenant** field to the connection form; the user enters a tenant ID or `common`, `organizations` or `consumers`, and the sign-in and token refresh go to that tenant. Without it, or with `false`, the connector signs in through `common`. See [2. Allowing Custom Tenant](#2-allowing-custom-tenant).
* `redirectUri` — Optional. The redirect URI the OneDrive file picker signs in with. Default `https://<your API host>/plugins/appmixer/microsoft/onedrive/picker`, the picker URI registered above. Set it only when you registered a different picker URI.
* `outputFilePrefix` — Optional. File name prefix of the CSV file that **List Events** (Calendar) and **List Files** and **Find Files or Folders** (SharePoint) create when their output is set to a file; the file is named `<prefix>-<component name>.csv`. Default `microsoft-export`.

Create the `appmixer:microsoft` configuration:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-9dc9d7fa31b34f93e40ed8a601465e62e48585c3%2Fmicrosoft-11.png?alt=media)

![appmixer:microsoft](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-73b4b5eca8ce87bae8a2e6a03ced95e51ba1e797%2Fmicrosoft-12.png?alt=media)

And add the keys:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-df5749cfa78dd29e1c6a876b08bbbadb137e1de9%2Fmicrosoft-13.png?alt=media)

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-5822eab613fcf9f572f7aa5a24e397302c1db31b%2Fimage%20(147).png?alt=media" alt=""><figcaption></figcaption></figure>

On newer Backoffice versions open **Connector Configuration**, find `appmixer:microsoft` (or add it with **Add Configuration**), click **Show Configuration Values** and add each key with **Add Item**, for example `microsoftTenant`:

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-c0204dc8063f2c21a7c3c10385d9724be0f3cd2a%2Fmicrosoft-24.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-9e9e5bc92729200e51038fbfd30d8c6d93290297%2Fmicrosoft-25.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-0c6c064d2a583680a9b8897df228054e408fd4e6%2Fmicrosoft-26.png?alt=media)

![](https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-f92db9fe4d0d6ce532708ee1d8f44b80c0acb48a%2Fmicrosoft-27.png?alt=media)

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:microsoft -u -d '{
  "clientId": "<application (client) id>",
  "clientSecret": "<client secret value>"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/microsoft.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
