Note: This sample was moved to the PnP-OfficeAddins repo and is located at https://github.com/OfficeDev/PnP-OfficeAddins/tree/main/Samples/auth/Office-Add-in-ASPNET-SSO
This repo is archived and no longer actively maintained. Security vulnerabilities may exist in the project, or its dependencies. If you plan to reuse or run any code from this repo, be sure to perform appropriate security checks on the code or dependencies first. Do not use this project as the starting point of a production Office Add-in. Always start your production code by using the Office/SharePoint development workload in Visual Studio, or the Yeoman generator for Office Add-ins, and follow security best practices as you develop the add-in.
The getAccessToken API in Office.js enables users who are signed into Office to get access to an AAD-protected add-in and to Microsoft Graph without needing to sign-in again. This sample is built on ASP.NET and Microsoft Identity Library (MSAL) .NET.
There are two versions of the sample in this repo, one of which has its own README file:
- In the Before folder is the starting point for the SSO walkthrough at at Create an ASP.NET Office Add-in that uses single sign-on. Please follow the instructions in the article.
- In the Complete folder is the completed sample you would have if you completed the walkthrough. To use this version, follow the instructions in the article Create an ASP.NET Office Add-in that uses single sign-on, but substitute "Complete" for "Before" in those instructions and skip the sections Code the client-side and Code the server-side.
Integrating data from online service providers increases the value and adoption of your add-ins. This code sample shows you how to connect your add-in to Microsoft Graph. Use this code sample to:
- See how to use the Single Sign-on (SSO) API
- Connect to Microsoft Graph from an Office Add-in.
- Build an Add-in using ASP.NET MVC, MSAL 4.x.x for .NET, and Office.js.
- Use the MSAL.NET Library to implement the OAuth 2.0 authorization framework in an add-in.
- Use the OneDrive REST APIs from Microsoft Graph.
- See how an add-in can fall back to an interactive sign-in in scenarios where SSO is not supported.
- Show a dialog using the Office UI namespace in scenarios where SSO is not supported.
- Use add-in commands in an add-in.
- Any platform and Office host combination that supports the IdentityAPI 1.3 requirement set.
To run this code sample, the following are required.
- Visual Studio 2019 or later.
- Office Developer Tools
- A Microsoft 365 account which you can get by joining the Microsoft 365 developer program that includes a free 1 year subscription to Microsoft 365.
- At least a few files and folders stored on OneDrive for Business in your Microsoft 365 subscription.
- A Microsoft Azure Tenant. This add-in requires Azure Active Directory (AD). Azure AD provides identity services that applications use for authentication and authorization. A trial subscription can be acquired here: Microsoft Azure.
| Solution | Author(s) |
|---|---|
| Office Add-in Microsoft Graph ASP.NET | Microsoft |
| Version | Date | Comments |
|---|---|---|
| 1.0 | May 10, 2017 | Initial release |
| 1.0 | September 15, 2017 | Added support for 2FA. |
| 1.0 | December 8, 2017 | Added extensive error handling. |
| 1.0 | January 7, 2019 | Added information about web application security practices. |
| 2.0 | November 5, 2019 | Added Display Dialog API fall back and use new version of SSO API. |
| 2.1 | August 11, 2020 | Removed preview note because the APIs have released. |
| 2.2 | June 15, 2021 | Updated NuGet packages and adjust code for breaking changes. |
THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.
The sample sends a hardcoded query parameter on the URL for the Microsoft Graph REST API. If you modify this code in a production add-in and any part of query parameter comes from user input, be sure that it is sanitized so that it cannot be used in a Response header injection attack.
We'd love to get your feedback about this sample. You can send your feedback to us in the Issues section of this repository.
Questions about developing Office Add-ins should be posted to Microsoft Q&A. Ensure your questions are tagged with office-js-dev and office-addins-dev.
Get a free sandbox, tools, and other resources you need to build solutions for the Microsoft 365 platform.
- Free developer sandbox Get a free, renewable 90-day Microsoft 365 E5 developer subscription.
- Sample data packs Automatically configure your sandbox by installing user data and content to help you build your solutions.
- Access to experts Access community events to learn from Microsoft 365 experts.
- Personalized recommendations Find developer resources quickly from your personalized dashboard.
Copyright (c) 2019 - 2021 Microsoft Corporation. All rights reserved.
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.