Microsoft Graph API Component

Interact with the Microsoft Graph API

Component key: ms-graph-api

Description

Microsoft's Graph API allows you to interact with many Microsoft products from one API endpoint. You can explore the Graph API using their Graph Explorer tool.

Connections

OAuth 2.0 Authorization Code

To use the Microsoft Graph API component, configure an OAuth 2.0 application through Active Directory in the Microsoft Azure Portal.

When creating the application you will be prompted to select the Supported account types. Under this section, be sure to select Accounts in any organizational directory (Any Azure AD directory - Multitenant) so that users outside of your organization (i.e. your customers) can authenticate. You will need to go to Platforms and add the Web platform. In that section you should add the OAuth 2.0 callback URL - https://oauth2.prismatic.io/callback - as a Redirect URI.

Next, go to Certificates & Secrets for the app and add a new Client Secret. Copy the value (not ID) of the secret for future use.

You will also need the Application (client) ID from the "Overview" page.

Next, supply the following values to the OAuth 2.0 connection:

• For Client ID and Client Secret enter the values that you got from the Microsoft Azure Portal.
• The Scopes your integration requires. You can find scopes on Microsoft Graph permissions reference, or by making test calls in the Graph Explorer.
• Additionally, ensure the offline_access scope is included in your app registration. It is essential to maintain your OAuth connection and receive refresh tokens. Without it, users will need to re-authenticate every hour.
• If you didn't select Multi-tenant when creating the Azure application, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.

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

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Microsoft's Graph API. If you have a multi-tenant application, you can use /common/ endpoints. If you have a single-tenant app, change these URLs to your tenant-specific ones.	https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Client ID
Client secret value	This is the 'value' (not ID) of the client secret you generated in Azure Portal.
Scopes	Add additional required scopes you identify on https://developer.microsoft.com/en-us/graph/graph-explorer to this list	https://graph.microsoft.com/User.Read.All offline_access
Token URL	The OAuth 2.0 Token URL for Microsoft's Graph API. If you have a multi-tenant application, you can use /common/ endpoints. If you have a single-tenant app, change these URLs to your tenant-specific ones.	https://login.microsoftonline.com/common/oauth2/v2.0/token

Actions

Raw Request

Send raw HTTP request to Microsoft Graph API | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt.	0
Method	The HTTP method to use.
Query Parameter	A 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.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type.	false
Retry Delay (ms)	The delay in milliseconds between retries.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input 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.	/me/joinedTeams
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries.	false

---