How to retrieve user profile information with Microsoft Graph in Azure?

dotnet add package Azure.Identity 
dotnet add package Microsoft.Graph 
dotnet add package dotenv.net 

• Create .env file - create .env file using following commands to hold secrets and open it into code editor to update it’s content.

touch .env
code .env

• Update .env file - Into the .env file add the below code. Replace actual values with CLIENT_ID and TENANT_ID. Actual values are recorded earlier in previous above section. To save file press ctrl + s and then to exit editor press ctrl + q.

CLIENT_ID="YOUR_CLIENT_ID"
TENANT_ID="YOUR_TENANT_ID"

This step is almost same as mentioned in previous article How to Implement Interactive Authentication with MSAL .NET in Azure?

Starter Code

Add the below starter code into the application. Replace the template code in Program.cs file through editor in Cloud Shell.

• Application editing - code command is used to open Program.cs file to edit it in the Cloud Shell.

code Program.cs

• Replace code - existing code of Program.cs to be replaced with the following code.

using Azure.Identity;
using Microsoft.Graph;
using dotenv.net;

// Loading environment variables from .env file
DotEnv.Load();

var envVars = DotEnv.Read();
string clientID = envVars["CLIENT_ID"];
string tenantID = envVars["TENANT_ID"];

// Verifying required environment variables
if (string.IsNullOrEmpty(clientID) || string.IsNullOrEmpty(tenantID))
{
    Console.WriteLine("CLIENT_ID and TENANT_ID environment variables are not set. Press any key to continue!");
    Console.ReadLine();
    return;
}

// DEFINE SCOPE - CONFIGURE AUTHENTICATION

// CREATE GRAPH CLIENT - RETRIEVE USER PROFILE

• Save & close - Press ctrl + s to save changes and continue.

Complete Code

In this section, first code part defines scopes and authentication configuration and second part creates graph client to retrieve user’s profile. Let’s complete the code and update the code for commented lines for the specific operations one by one with description.

• Define scope and configure authentication - Locate // DEFINE SCOPE - CONFIGURE AUTHENTICATION comment, then add following code directly beneath comment. InteractiveBrowserCredential is used to create it’s instance for user profile retrieval .

// Define Scopes
var scopes = new[] { "User.Read" };

// Configure Authentication
var interactiveBrowserCredentialOptions = new InteractiveBrowserCredentialOptions
{
    ClientID = clientID,
    TenantID = tenantID,
    RedirectURI = new Uri("http://localhost")
};

var interactiveBrowserCredential = new InteractiveBrowserCredential(interactiveBrowserCredentialOptions);

• Create graph client and retrieve user profile - Locate // CREATE GRAPH CLIENT - RETRIEVE USER PROFILE comment, then add following code directly beneath comment. Here, GraphServiceClient is created to get the user profile details using GetUserProfile.

// Create Microsoft Graph client
var gGraphServiceClient = new GraphServiceClient(interactiveBrowserCredential);

// Retrieve user profile
Console.WriteLine("Retrieve user profile!");
Console.ReadLine();
await GetUserProfile(gGraphServiceClient);

// Get and print user profile information
async Task GetUserProfile(GraphServiceClient gGraphServiceClient)
{
    try
    {
        var me = await gGraphServiceClient.Me.GetAsync();

        Console.WriteLine($"User ID : {me?.Id}");
        Console.WriteLine($"Display Name : {me?.DisplayName}");
        Console.WriteLine($"Principal Name : {me?.UserPrincipalName}");

        Console.ReadLine();
    }
    catch (Exception ex)
    {
        Console.WriteLine($"Error message: {ex.Message}");// Write error
        Console.ReadLine();
    }
}

Now it’s time save all the changes and close the modified file by pressing Ctrl + s to save file and then Ctrl + q to exit the editor. Complete code of the Program.cs file is attached with this article.

Run application

Now application is complete and next task is to run the application to validate the results.

• Run application - dotnet run command is used as following to run an app:

dotnet run

• Application will be open default browser and it will prompt to select account for the authenticate.

• First time authentication is required for the registered application as receive “Permissions requested” notification confirm to approve application to be sign in and to allow access to data given it access by selecting Accept.

  

• Console will output result as like below.

Retrieve user profile!
User Id : 7C2....
Display Name : …
Principal Name : …

• Next time when application is executed there will no required to Accept “Permissions requested” because the granted earlier permission was cached.

Clean up resources

Once finished the exercise it’s recommended to delete cloud resources are being created to avoid the unnecessary resource usage and any future costs. Deleting a resource group will delete all resources contained within it. Perform following steps one by one in to Azure Portal to achieve this:

• Navigate to resource group which is being created here and view it’s contents.

• Delete resource group selection from the toolbar.

• Choose resource group name and then follow next directions to delete resource group and all the resources it contains.

Summary

A complete process flow is described to retrieve user profile information with Microsoft Graph in Azure. First, registered the application using Microsoft identity platform and created a .NET console application. Then, InteractiveBrowserCredential is used to create it’s instance for user profile retrieval. GraphServiceClient is created to get the user profile details using GetUserProfile. Last, application is executed using dotnet run and clean up created resources. Now, one will be able to configure permissions and interact with the Microsoft Graph.