The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API that can be used server-side and in the browser.

• Microsoft Graph JavaScript Client Library
  • Installation
    • Via npm
    • Via Script Tag
  • Getting started
    • 1. Register your application
    • 2. Create a Client Instance
    • 3. Make requests to the graph
  • Documentation
    • HTTP Actions
    • Chained APIs to call Microsoft Graph
    • OData system query options - Query Parameters
    • Batch multiple requests into single HTTP request
    • Cancel a HTTP request
    • Configurations to your request
      • Query
      • Version
      • Headers
      • Options
      • MiddlewareOptions
      • ResponseType
    • Upload large files to OneDrive, Outlook, Print API
    • Page Iteration
    • Getting Raw Response
    • Creating an instance of TokenCredentialAuthenticationProvider
  • Questions and comments
  • Contributing
  • Additional resources
  • Third Party Notices
  • Security Reporting
  • License
  • We Value and Adhere to the Microsoft Open Source Code of Conduct

Node.js 10 LTS or higher.

npm install @microsoft/microsoft-graph-client

import @microsoft/microsoft-graph-client into your module.

Also, you will need to import any fetch polyfill which suits your requirements. Following are some fetch polyfills -

• isomorphic-fetch.
• cross-fetch
• whatwg-fetch

import "isomorphic-fetch"; // or import the fetch polyfill you installed
import { Client } from "@microsoft/microsoft-graph-client";

Include graph-js-sdk.js in your HTML page.

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@microsoft/microsoft-graph-client/lib/graph-js-sdk.js"></script>

In case your browser doesn't have support for Fetch [support] or Promise [support], you need to use polyfills like github/fetch for fetch and es6-promise for promise.

<!-- polyfilling promise -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.auto.min.js"></script>

<!-- polyfilling fetch -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/whatwg-fetch/dist/fetch.umd.min.js"></script>

<!-- depending on your browser you might wanna include babel polyfill -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@babel/polyfill@7.4.4/dist/polyfill.min.js"></script>

To call Microsoft Graph, your app must acquire an access token from the Microsoft identity platform. Learn more about this -

• Authentication and authorization basics for Microsoft Graph
• Register your app with the Microsoft identity platform

The Microsoft Graph client is designed to make it simple to make calls to Microsoft Graph. You can use a single client instance for the lifetime of the application.

For information on how to create a client instance, see Creating Client Instance

Once you have authentication setup and an instance of Client, you can begin to make calls to the service. All requests should start with client.api(path) and end with an action.

Example of getting user details:

try {
	let userDetails = await client.api("/me").get();
	console.log(userDetails);
} catch (error) {
	throw error;
}

Example of sending an email to the recipients:

// Construct email object
const mail = {
	subject: "Microsoft Graph JavaScript Sample",
	toRecipients: [
		{
			emailAddress: {
				address: "example@example.com",
			},
		},
	],
	body: {
		content: "<h1>MicrosoftGraph JavaScript Sample</h1>Check out https://github.com/microsoftgraph/msgraph-sdk-javascript",
		contentType: "html",
	},
};
try {
	let response = await client.api("/me/sendMail").post({ message: mail });
	console.log(response);
} catch (error) {
	throw error;
}

For more information, refer: Calling Pattern, Actions, Query Params, API Methods and more.

We'd love to get your feedback about the Microsoft Graph JavaScript client library. You can send your questions and suggestions to us in the Issues section of this repository.

Please see the contributing guidelines.

• Microsoft Graph website

• The Microsoft Graph TypeScript definitions enable editors to provide intellisense on Microsoft Graph objects including users, messages, and groups.

  • @microsoft/microsoft-graph-types or @types/microsoft-graph
  • @microsoft/microsoft-graph-types-beta

• Build React Native apps with Microsoft Graph

• Build Angular single-page apps with Microsoft Graph

• Build Node.js Express apps with Microsoft Graph

• Microsoft Graph Toolkit: UI Components and Authentication Providers for Microsoft Graph

• Office Dev Center

See Third Party Notices for information on the packages that are included in the package.json

If you find a security issue with our libraries or services please report it to secure@microsoft.com with as much detail as possible. Your submission may be eligible for a bounty through the Microsoft Bounty program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. We encourage you to get notifications of when security incidents occur by visiting this page and subscribing to Security Advisory Alerts.

Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License (the "License");

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.