Skip to content

Commit 8a19c10

Browse files
authored
copy edit pass on README.md (#152)
1 parent 81b6457 commit 8a19c10

File tree

1 file changed

+18
-22
lines changed

1 file changed

+18
-22
lines changed

README.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,25 @@ products:
66
- azure
77
- azure-active-directory
88
page_type: sample
9-
description: "A sample that shows how to protect an ASP.NET Core Web API using Microsoft Identity Platform."
9+
description: "Protect an ASP.NET Core Web API with the Microsoft identity platform."
1010
---
11-
12-
# Protecting an ASP.NET Core Web API using Microsoft Identity Platform
11+
# Protecting an ASP.NET Core Web API using Microsoft identity platform
1312

1413
[![Build status](https://identitydivision.visualstudio.com/IDDP/_apis/build/status/AAD%20Samples/.NET%20client%20samples/active-directory-dotnet-native-aspnetcore-v2)](https://identitydivision.visualstudio.com/IDDP/_build/latest?definitionId=516)
1514

1615
## About this sample
1716

1817
### Scenario
1918

20-
In this scenario, we would be protecting a Web API using the Microsoft Identity Platform. This will ensure that the Web API is only accessible to authenticated users. In these samples we would work with Apps who authenticate users using both **Work and School accounts** or **Microsoft Personal accounts (formerly live account)**.
19+
In this scenario, we protect a web API using the Microsoft identity platform. This ensures that the web API is accessible only to authenticated users. In these samples, we work with apps that authenticate users using both **Work and school accounts** and personal **Microsoft accounts (MSA)**.
2120

22-
We will also enrich the Web API to use the [on-behalf of flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) to call other Web APIs protected by the Microsoft Identity Platform.
21+
We also enhance the web API to use the [on-behalf-of flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) to call other web APIs protected by the Microsoft identity platform.
2322

24-
### Pre-requisites
23+
### Prerequisites
2524

26-
- Install .NET Core for Windows by following the instructions at [dot.net/core](https://dot.net/core), which will include [Visual Studio 2019](https://aka.ms/vsdownload).
27-
- An Internet connection
28-
- An Azure Active Directory (Azure AD) tenant. For more information on how to get an Azure AD tenant, see [How to get an Azure AD tenant](https://azure.microsoft.com/en-us/documentation/articles/active-directory-howto-tenant/)
29-
- A user account in your Azure AD tenant, or a Microsoft personal account
25+
- Install .NET Core for Windows by following the instructions at [dot.net/core](https://dot.net/core) which includes [Visual Studio 2019](https://aka.ms/vsdownload).
26+
- An Azure Active Directory (Azure AD) tenant. For more information on how to get an Azure AD tenant, see [Quickstart: Set up a tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant)
27+
- A user account in your Azure AD tenant, or a personal Microsoft account (MSA)
3028

3129
### Step 1: Clone or download this repository
3230

@@ -36,28 +34,26 @@ From your shell or command line:
3634
git clone https://github.com/Azure-Samples/active-directory-dotnet-native-aspnetcore-v2.git
3735
```
3836

39-
> Given that the name of the sample is pretty long, that it has sub-folders and so are the name of the referenced NuGet packages, you might want to clone it in a folder close to the root of your hard drive, to avoid file size limitations on Windows.
37+
> TIP: To avoid path length limitations on Windows, you may need to clone into a directory with a shorter name or near the root of your drive.
4038
4139
### Structure of the repository
4240

43-
This repository contains a progressive tutorial made up of the following chapters:
44-
45-
Sub folder | Description
46-
----------------------------- | -----------
47-
[1. Desktop app calls a protected Web API](1.%20Desktop%20app%20calls%20Web%20API/README-incremental.md) | In the first chapter, we would protect an ASP.Net Core Web API using the Microsoft Identity Platform. The Web API will be protected using Azure Active Directory OAuth Bearer Authorization. The Web API is called by a .NET Desktop WPF application. In this chapter, the desktop application uses the [Microsoft Authentication Library for .NET (MSAL.NET)](https://aka.ms/msal-net) to sign-in the user to acquire an [Access Token](https://docs.microsoft.com/azure/active-directory/develop/access-tokens) for the protected Web API. </p> ![Topology](1.%20Desktop%20app%20calls%20Web%20API/ReadmeFiles/topology.png)
48-
[2. Web API now calls Microsoft Graph](2.%20Web%20API%20now%20calls%20Microsoft%20Graph/README-incremental.md) | In the second chapter we enhance the Web API to call Microsoft Graph using the on-behalf flow to represent the user signed-in in the desktop application to Microsoft Graph. In this chapter, the Web API uses the [MSAL.NET](https://aka.ms/msal-net) to acquire an [Access Token](https://docs.microsoft.com/azure/active-directory/develop/access-tokens) for Microsoft Graph using the [on-behalf-of](https://aka.ms/msal-net-on-behalf-of) flow </p> ![Topology](2.%20Web%20API%20now%20calls%20Microsoft%20Graph/ReadmeFiles/topology.png)
49-
[3.-Web API and client share the same app id and signs-in MSA users](3.-Web-api-call-Microsoft-graph-for-personal-accounts/README-incremental.md) | In the third chapter, we present another pattern where a tightly-knit client and Web API share the same client id (app id). In this one we will sign-in users with Microsoft Personal Accounts. The sign-in flow and the call to Web API uses the same flow as chapter 2. </p> ![Topology](3.-Web-api-call-Microsoft-graph-for-personal-accounts/ReadmeFiles/topology.png)
50-
[4. Client app calls a Web API with Proof of Possession(PoP)](4.-Console-app-calls-web-API-with-PoP/README-incremental.md) | In this chapter, the ASP.NET Core Web API is expecting an [Access Token](https://docs.microsoft.com/azure/active-directory/develop/access-tokens) with a Proof of Possession key. </p> ![Topology](1.%20Desktop%20app%20calls%20Web%20API/ReadmeFiles/topology.png)
41+
This repository contains a progressive tutorial made up of the following chapters. We recommend you follow the tutorial in the order presented, but you can try out individual chapters if you wish.
5142

52-
> Note: We advise you to follow the tutorial in the order presented, but you can still try out individual chapters if you so wish.
43+
| Subfolder | Description |
44+
|--|--|
45+
| [1. Desktop app calls a protected Web API](1.%20Desktop%20app%20calls%20Web%20API/README-incremental.md) | In the first chapter, we protect an ASP.Net Core Web API using the Microsoft identity platform. The Web API will be protected using Azure Active Directory OAuth Bearer Authorization. The Web API is called by a .NET Desktop WPF application. In this chapter, the desktop application uses the [Microsoft Authentication Library for .NET (MSAL.NET)](https://aka.ms/msal-net) to sign-in the user to acquire an [Access Token](https://docs.microsoft.com/azure/active-directory/develop/access-tokens) for the protected Web API. </p> ![Topology](1.%20Desktop%20app%20calls%20Web%20API/ReadmeFiles/topology.png) |
46+
| [2. Web API now calls Microsoft Graph](2.%20Web%20API%20now%20calls%20Microsoft%20Graph/README-incremental.md) | In the second chapter we enhance the Web API to call Microsoft Graph using the on-behalf flow to represent the user signed-in in the desktop application to Microsoft Graph. In this chapter, the Web API uses the [MSAL.NET](https://aka.ms/msal-net) to acquire an [Access Token](https://docs.microsoft.com/azure/active-directory/develop/access-tokens) for Microsoft Graph using the [on-behalf-of](https://aka.ms/msal-net-on-behalf-of) flow </p> ![Topology](2.%20Web%20API%20now%20calls%20Microsoft%20Graph/ReadmeFiles/topology.png) |
47+
| [3. Web API and client share the same app id and signs-in MSA users](3.-Web-api-call-Microsoft-graph-for-personal-accounts/README-incremental.md) | In the third chapter, we present another pattern where a tightly-knit client and Web API share the same client id (app id). In this one we will sign-in users with Microsoft Personal Accounts. The sign-in flow and the call to Web API uses the same flow as chapter 2. </p> ![Topology](3.-Web-api-call-Microsoft-graph-for-personal-accounts/ReadmeFiles/topology.png) |
48+
| [4. Client app calls a Web API with Proof of Possession (PoP)](4.-Console-app-calls-web-API-with-PoP/README-incremental.md) | In this chapter, the ASP.NET Core Web API is expecting an [Access Token](https://docs.microsoft.com/azure/active-directory/develop/access-tokens) with a Proof of Possession key. </p> ![Topology](1.%20Desktop%20app%20calls%20Web%20API/ReadmeFiles/topology.png) |
5349

54-
- Start with the chapter [1. Desktop app calls Web API](1.%20Desktop%20app%20calls%20Web%20API/README-incremental.md) where you will learn how to protect a Web API with the Azure AD.
50+
We recommend that you start with chapter [1. Desktop app calls Web API](1.%20Desktop%20app%20calls%20Web%20API/README-incremental.md), where you learn how to protect a web API with Azure AD.
5551

5652
## Community Help and Support
5753

5854
Use [Stack Overflow](http://stackoverflow.com/questions/tagged/msal) to get support from the community.
5955
Ask your questions on Stack Overflow first and browse existing issues to see if someone has asked your question before.
60-
Make sure that your questions or comments are tagged with [`msal` `dotnet`].
56+
Tag your questions or comments with [`msal` `dotnet`].
6157

6258
If you find a bug in the sample, please open an issue on [GitHub Issues](https://github.com/Azure-Samples/active-directory-dotnet-native-aspnetcore-v2/issues).
6359

0 commit comments

Comments
 (0)