Skip to main content

Microsoft Graph API Connector

Microsoft Graph API Microsoft Graph API is a unified REST API that provides access to data across Microsoft 365 services. This component allows interacting with many Microsoft products from a single API endpoint.

The Graph API can be explored using the Graph Explorer tool.

API Documentation​

This component was built using Microsoft Graph REST API v1.0.

Connections​

OAuth 2.0 Authorization Code​

OAuth 2.0 Authorization Code Connectivity for Microsoft Graph API

Prerequisites​

Setup Steps​

  1. Navigate to Azure Active Directory > App registrations in the Microsoft Azure Portal.

  2. Create a new application registration.

  3. When prompted to select Supported account types, select Accounts in any organizational directory (Any Azure AD directory - Multitenant) to allow users outside of the organization to authenticate.

  4. Go to Platforms and add the Web platform.

  5. Add the OAuth 2.0 callback URL as a Redirect URI: https://oauth2.integrations.acme.com/callback

  6. Navigate to Certificates & Secrets and add a new Client Secret. Copy the value (not ID) for future use.

  7. Locate the Application (client) ID on the Overview page.

Configure the Connection​

Supply the following values to the OAuth 2.0 connection:

  • Client ID: The Application (client) ID from the Azure Portal.
  • Client Secret: The secret value copied from Certificates & Secrets.
  • Scopes: The OAuth permission scopes required by the integration. Scopes can be found in the Microsoft Graph permissions reference or by making test calls in the Graph Explorer.
  • Authorize URL and Token URL: For single-tenant applications, replace these with tenant-specific URLs. Multi-tenant applications can use the default /common/ endpoints.

Important: Ensure the offline_access scope is included in the app registration. This scope is essential for receiving refresh tokens. Without it, users must re-authenticate every hour.

For more information on authenticating against the Microsoft Graph API, refer to the Microsoft documentation.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for Microsoft Graph API. For multi-tenant applications, use /common/ endpoints. For single-tenant apps, replace with tenant-specific URLs.https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token URLThe OAuth 2.0 Token URL for Microsoft Graph API. For multi-tenant applications, use /common/ endpoints. For single-tenant apps, replace with tenant-specific URLs.https://login.microsoftonline.com/common/oauth2/v2.0/token
ScopesSpace-separated list of OAuth permission scopes. Find available scopes at https://developer.microsoft.com/en-us/graph/graph-explorerhttps://graph.microsoft.com/User.Read.All offline_access
Client IDThe Client ID from the Azure AD application registration.
Client SecretThis is the 'value' (not ID) of the client secret you generated in Azure Portal.

OAuth 2.0 Client Credentials​

Authenticates actions in all Microsoft's Graph API services.

The OAuth 2.0 Client Credentials flow is designed for service-to-service authentication where no user interaction is required. This flow is ideal for daemon services, background processes, and server-to-server integrations that need to access Microsoft Graph API resources using the application's own identity rather than on behalf of a user.

For more information on the Client Credentials flow, refer to the Microsoft documentation.

Prerequisites​

  • A Microsoft Azure account with admin access
  • Access to the Microsoft Azure Portal
  • Administrative consent authority to grant Application permissions

Setup Steps​

  1. Navigate to Azure Active Directory > App registrations in the Microsoft Azure Portal.

  2. Create a new application registration or select an existing application.

  3. When prompted to select Supported account types, choose the appropriate option:

    • Single tenant: Select Accounts in this organizational directory only for tenant-specific access
    • Multi-tenant: Select Accounts in any organizational directory to allow access across multiple tenants

  4. Navigate to Certificates & Secrets and add a new Client Secret. Copy the value (not ID) for future use.

  5. Navigate to API permissions and add the required Microsoft Graph Application permissions (not Delegated permissions):

    • Click Add a permission > Microsoft Graph > Application permissions
    • Select the permissions required for the integration (e.g., User.Read.All, Mail.Read)
    • Click Grant admin consent to approve the permissions (admin consent is required for Application permissions)
    • Refer to the Microsoft Graph permissions reference for available Application permissions

  6. Locate the Application (client) ID on the Overview page.

  7. Locate the Directory (tenant) ID on the Overview page. This value is required for tenant-specific endpoints.

Configure the Connection​

Supply the following values to the OAuth 2.0 Client Credentials connection:

  • Client ID: The Application (client) ID from the Azure Portal
  • Client Secret: The secret value copied from Certificates & Secrets
  • Tenant ID: The Directory (tenant) ID from the Overview page (not /common/ - must be tenant-specific)

Important Considerations:

  • Application permissions only: The Client Credentials flow requires Application permissions (app roles), not Delegated permissions. Application permissions must be granted by an administrator.
  • Tenant-specific authentication: Unlike user-based OAuth flows, the Client Credentials flow requires tenant-specific endpoints and cannot use the /common/ endpoint.
  • No user context: Actions performed using this connection execute under the application's identity, not on behalf of any specific user.
  • Admin consent required: An organization administrator must grant admin consent for all Application permissions before the connection can obtain tokens.

For more information on authenticating against the Microsoft Graph API using the Client Credentials flow, refer to the Microsoft documentation.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Base URLThe base URL for the Microsoft Graph API. Depending on your cloud environment, you can choose the correct one here.https://graph.microsoft.com
Microsoft Entra ID EndpointThe Microsoft Entra ID endpoint for the Microsoft Graph API. You can find this in the Azure portal or here.https://login.microsoftonline.com
TenantThe tenant ID or name for the Microsoft Graph API. This is the ID or name of the tenant that you are connecting to.
Client IDClient Id of your Azure application.
Client SecretClient Secret generated under 'Certificates & Secrets' in your Azure application.
ScopesMicrosoft Graph API Scopes.https://graph.microsoft.com/.default

Actions​

Raw Request​

Send raw HTTP request to Microsoft Graph API.

InputCommentsDefault
ConnectionThe Microsoft Graph API connection to use.
URLInput the path only (/me/joinedTeams), The base URL is already included (https://graph.microsoft.com/v1.0). For example, to connect to https://graph.microsoft.com/v1.0/me/joinedTeams, only /me/joinedTeams is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false