How to get profile image from Azure Active Directory using Microsoft Graph?

Question

I am implementing Microsoft Azure Active Directory authentication using Microsoft Graph and OAuth2 using this tutorial.

Here is my call which fetches me the displayName, givenName, surName, mail, etc.

$graph  = new Graph();
$graph->setAccessToken($accessToken->getToken());

$user   = $graph->createRequest('GET', '/me?$select=displayName,givenName,surName,mail,mailboxSettings,userPrincipalName') 
                ->setReturnType(ModelUser::class)
                ->execute();

$fname  = $user->getGivenName();
$mail   = $user->getMail();

Now using the same call, how can I fetch profile image of the user? I don't want to make a separate API call, but want to fetch the photo in same call.

How can I get the profile image?

Answer 1

You cant get users profile image from AAD id token.

The best way of getting the picture is through MS Graph.

In MS Graph API, you can use the below endpoint to fetch photo from Azure AD:

https://graph.microsoft.com/v1.0/users/{id | userPrincipalName}/photo/$value

To get this, you need to set the app permission as

To Get profile picture you need at least one of the following permissions User.ReadBasic.All; User.Read.All; User.ReadWrite.All

C# code sample:

public static async Task<System.Drawing.Image> GetMePhotoAsync()
        {
            try
            {
                // GET /me
                Stream photoresponse = await graphClient.Me.Photo.Content.Request().GetAsync();

                if (photoresponse != null)
                {
                    MemoryStream ms = new MemoryStream();
                    photoresponse.CopyTo(ms);
                    System.Drawing.Image i = System.Drawing.Image.FromStream(ms);

                    return i;
                }
                else
                { return null; }
            }
            catch (ServiceException ex)
            {
                Console.WriteLine($"Error getting signed-in user profilephoto: {ex.Message}");
                return null;
            }
        }

Reference:

Azure AD Get photo