Microsoft (Client Credentials)

​

Overview

​

Pre-built tooling

​

Pre-built integrations

​

Access requirements

​

Setup guide

​

Useful links

​

Common Permissions

​

API gotchas

• Microsoft has a unified OAuth system for their various APIs. This provider should work for most of them (e.g. Microsoft EntraID, OneNote, Onedrive, Outlook, Sharepoint Online, Microsoft Teams etc.).
• You can find permissions required for each API call in their corresponding API methods section, i.e, to retrieve a list of notebook objects from Onenote, you can have a look at List Notebooks permissions.
• See particularly the tenantId parameter under Get a token.
• This tenantId parameter must be provided as extra configuration to the frontend SDK.
• Microsoft offers a tool that allows you to construct and perform Graph API queries and see their response for any apps on which you have an admin, developer, or tester role. For more information you can check Microsoft Graph Explorer.
• Please be aware that the Microsoft Graph API implements throttling to manage the volume of requests. For more information on handling throttling, refer to the Microsoft Graph Throttling Guidance.
• Microsoft Graph API has different versions (v1.0 and beta). The v1.0 endpoint is for production use, while the beta endpoint contains features that are still in preview.
• When requesting Application Permissions that require admin consent, an Microsoft Entra ID administrator must pre-authorize the permissions. Without admin consent, the app cannot obtain tokens for those scopes.
• For multitenant applications, each tenant administrator must grant consent to the app’s required permissions before access is granted in their tenant.
• The .default scope is a special scope that tells Azure AD to issue a token containing all the Application Permissions that have already been granted (consented) for your app on that resource. Using .default ensures your app receives permissions consistent with those configured and consented at the tenant or organization level.
• The .default scope can’t be combined with the scopes registered in the Azure portal. So either just use the .default scope or remove it to list out explicit parameters that are required. If you attempt to combine them you’ll receive the following error

.default scope can't be combined with resource-specific scopes

• Since Microsoft (Client Credentials) does not involve a user, a Microsoft Entra ID administrator must grant consent to the required Application Permissions in advance. This can be done through the Azure Portal or by using the admin consent endpoint.
  Contribute API gotchas by editing this page