page_type

name

description

languages

products

urlFragment

extensions

sample

Enable your Blazor Single-page Application (SPA) to sign-in users with the Microsoft identity platform

aspnetcore-blazor

csharp

azure-active-directory

ms-graph

azure-active-directory

msal-net

ms-identity-blazor-wasm

services
ms-identity

platform
DotNet

endpoint
AAD v2.0

level
200

client
ASP.NET Core Blazor WebAssembly Web App

service
Microsoft Graph

Enable your Blazor Single-page Application (SPA) to sign-in users with the Microsoft identity platform

Overview
Scenario
Prerequisites
Setup the sample
Explore the sample
Troubleshooting
About the code
Next Steps
Contributing
Learn More

Overview

This sample demonstrates a ASP.NET Core Blazor WebAssembly Web App calling Microsoft Graph.

ℹ️ To learn how applications integrate with Microsoft Graph, consider going through the recorded session:: An introduction to Microsoft Graph for developers

Scenario

The client ASP.NET Core Blazor WebAssembly Web App uses the to authenticate a user and obtain a JWT ID Token and an Access Token from Azure AD.
The access token is used as a bearer token to authorize the user to call the Microsoft Graph protected by Azure AD.

Prerequisites

Install .NET.
Either Visual Studio or Visual Studio Code and .NET Core SDK
An Azure AD tenant. For more information, see: How to get an Azure AD tenant
A user account in your Azure AD tenant.

This sample will not work with a personal Microsoft account. If you're signed in to the Azure portal with a personal Microsoft account and have not created a user account in your directory before, you will need to create one before proceeding.

Setup the sample

Step 1: Clone or download this repository

From your shell or command line:

git clone https://github.com/Azure-Samples/ms-identity-blazor-wasm.git

or download and extract the repository .zip file.

⚠️ To avoid path length limitations on Windows, we recommend cloning into a directory near the root of your drive.

Step 2: Navigate to project folder

cd WebApp-graph-user/Call-MSGraph/blazorwasm-calls-MS-graph

Step 3: Register the sample application(s) in your tenant

There is one project in this sample. To register it, you can:

follow the steps below for manually register your apps
or use PowerShell scripts that:
- automatically creates the Azure AD applications and related objects (passwords, permissions, dependencies) for you.
- modify the projects' configuration files.

Expand this section if you want to use this automation:

> :warning: If you have never used **Microsoft Graph PowerShell** before, we recommend you go through the [App Creation Scripts Guide](./AppCreationScripts/AppCreationScripts.md) once to ensure that your environment is prepared correctly for this step.

1. On Windows, run PowerShell as **Administrator** and navigate to the root of the cloned directory
1. In PowerShell run:

   ```PowerShell
   Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -Force
   ```

1. Run the script to create your Azure AD application and configure the code of the sample application accordingly.
1. For interactive process -in PowerShell, run:

   ```PowerShell
   cd .\AppCreationScripts\
   .\Configure.ps1 -TenantId "[Optional] - your tenant id" -AzureEnvironmentName "[Optional] - Azure environment, defaults to 'Global'"
   ```

> Other ways of running the scripts are described in [App Creation Scripts guide](./AppCreationScripts/AppCreationScripts.md). The scripts also provide a guide to automated application registration, configuration and removal which can help in your CI/CD scenarios.

Choose the Azure AD tenant where you want to create your applications

To manually register the apps, as a first step you'll need to:

Sign in to the Azure portal.
If your account is present in more than one Azure AD tenant, select your profile at the top right corner in the menu on top of the page, and then switch directory to change your portal session to the desired Azure AD tenant.

Register the webApp app (WebApp-blazor-wasm)

Navigate to the Azure portal and select the Azure Active Directory service.
Select the App Registrations blade on the left, then select New registration.
In the Register an application page that appears, enter your application's registration information:
1. In the Name section, enter a meaningful application name that will be displayed to users of the app, for example WebApp-blazor-wasm.
2. Under Supported account types, select Accounts in this organizational directory only
3. Select Register to create the application.
In the Overview blade, find and note the Application (client) ID. You use this value in your app's configuration file(s) later in your code.
In the app's registration screen, select the Authentication blade to the left.
If you don't have a platform added, select Add a platform and select the Single-page application option.
1. In the Redirect URI section enter the following redirect URI:
  1. https://localhost:44314/authentication/login-callback
2. In the Front-channel logout URL section, set it to https://localhost:44314/signout-oidc.
3. Click Save to save your changes.
Since this app signs-in users, we will now proceed to select delegated permissions, which is is required by apps signing-in users.
1. In the app's registration screen, select the API permissions blade in the left to open the page where we add access to the APIs that your application needs:
2. Select the Add a permission button and then:
3. Ensure that the Microsoft APIs tab is selected.
4. In the Commonly used Microsoft APIs section, select Microsoft Graph
5. In the Delegated permissions section, select User.Read in the list. Use the search box if necessary.
6. Select the Add permissions button at the bottom.

Configure Optional Claims

Still on the same app registration, select the Token configuration blade to the left.
Select Add optional claim:
1. Select optional claim type, then choose ID.
2. Select the optional claim acct.
Provides user's account status in tenant. If the user is a member of the tenant, the value is 0. If they're a guest, the value is 1.
1. Select Add to save your changes.

Configure the webApp app (WebApp-blazor-wasm) to use your app registration

Open the project in your IDE (like Visual Studio or Visual Studio Code) to configure the code.

In the steps below, "ClientID" is the same as "Application ID" or "AppId".

Open the blazorwasm-calls-MS-graph\wwwroot\appsettings.json file.
Find the key Enter_Application_ID_here and replace the existing value with the application ID (clientId) of WebApp-blazor-wasm app copied from the Azure portal.
Find the key Enter_Tenant_ID_here and replace the existing value with 'https://login.microsoftonline.com/'+$tenantId.

Step 4: Running the sample

From your shell or command line, execute the following commands:

    cd WebApp-graph-user/Call-MSGraph/blazorwasm-calls-MS-graph
    dotnet run

Explore the sample

If you are using incognito mode of browser to run this sample then allow third party cookies.

Open your browser and navigate to https://localhost:44314.
Select the Sign in button on the top right corner. You will see claims from the signed-in user's token.
Select Profile from navigation bar on the left. If user has signed-in then information fetched from Microsoft Graph is displayed, otherwise login screen will appear.

ℹ️ Did the sample not work for you as expected? Then please reach out to us using the GitHub Issues page.

We'd love your feedback!

Were we successful in addressing your learning objective? Do consider taking a moment to share your experience with us.

About the code

In Program.cs, Main method registers AddMsalAuthentication as explained below:
```
 builder.Services.AddMsalAuthentication(options =>
 {
     builder.Configuration.Bind("AzureAd", options.ProviderOptions.Authentication);
 });
```
AddMsalAuthentication is an extension method provided by the Microsoft.Authentication.WebAssembly.Msal package and it provides support for authenticating users with the Microsoft Identity Platform.
Index.razor is the landing page when application starts. Index.razor contains child component called UserClaims. If user is authenticated successfully, UserClaims displays a few claims present in the ID Token issued by Azure AD.

In the UserClaimsBase.cs class, GetClaimsPrincipalData method retrieves signed-in user's claims using the GetAuthenticationStateAsync() method of the AuthenticationStateProvider class.

 public class UserClaimsBase: ComponentBase
 {
     [Inject]
     private AuthenticationStateProvider AuthenticationStateProvider { get; set;
     }
     protected string _authMessage;
     protected IEnumerable<Claim> _claims = Enumerable.Empty<Claim>();
     private string[] returnClaims = { "name", "preferred_username", "tid", "oid" };
     protected override async Task OnInitializedAsync()
     {
         await GetClaimsPrincipalData();
     }
     private async Task GetClaimsPrincipalData()
     {
         var authState = await AuthenticationStateProvider.GetAuthenticationStateAsync();
         var user = authState.User;

         if (user.Identity.IsAuthenticated)
         {
             _authMessage = $"{user.Identity.Name} is authenticated.";
             _claims = user.Claims.Where(x => returnClaims.Contains(x.Type));
         }
         else
         {
             _authMessage = "The user is NOT authenticated.";
         }
     }
 }

In Program.cs, Main method registers AddMicrosoftGraphClient as explained below:
```
builder.Services.AddMicrosoftGraphClient("https://graph.microsoft.com/User.Read");
```
AddMsalAuthentication is an extension method provided by GraphClientExtensions.cs class.

UserProfile.razor component displays user information retrieved by GetUserProfile method of UserProfileBase.cs.

UserProfileBase.cs calls Microsoft Graph /me endpoint to retrieve user information.

public class UserProfileBase : ComponentBase
{
    [Inject]
    GraphServiceClient GraphClient { get; set; }
    protected User _user=new User();
    protected override async Task OnInitializedAsync()
    {
        await GetUserProfile();
    }
    private async Task GetUserProfile()
    {
        ...
            var request = GraphClient.Me.Request();
            _user = await request.GetAsync();
        ...
    }
}

Deployment

See README.md to deploy this sample to Azure.

Community Help and Support

Use Stack Overflow to get support from the community. Ask your questions on Stack Overflow first and browse existing issues to see if someone has asked your question before. Make sure that your questions or comments are tagged with [azure-active-directory ms-identity msal].

If you find a bug in the sample, raise the issue on GitHub Issues.

To provide feedback on or suggest features for Azure Active Directory, visit User Voice page.

Contributing

If you'd like to contribute to this sample, see CONTRIBUTING.MD.

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.

mirza-developer / azure-appfolder-sample

Enable your Blazor Single-page Application (SPA) to sign-in users with the Microsoft identity platform

Overview

Scenario

Prerequisites

Setup the sample

Step 1: Clone or download this repository

Step 2: Navigate to project folder

Step 3: Register the sample application(s) in your tenant

Choose the Azure AD tenant where you want to create your applications

Register the webApp app (WebApp-blazor-wasm)

Configure Optional Claims

Configure the webApp app (WebApp-blazor-wasm) to use your app registration

Step 4: Running the sample

Explore the sample

We'd love your feedback!

About the code

Deployment

Community Help and Support

Contributing

Learn More

About

Languages