Get profilePhoto

Artigo
08/08/2024

Namespace: microsoft.graph

Obtenha a profilePhoto específica ou seus metadados (propriedades profilePhoto).

Os tamanhos suportados das fotos em HD do Microsoft 365 são os seguintes: 48x48, 64x64, 96x96, 120x120, 240x240, 360x360, 432x432, 504x504 e 648x648. As fotografias podem ter qualquer dimensão se estiverem armazenadas no ID do Microsoft Entra.

Você pode obter os metadados da maior foto disponível ou especificar um tamanho para obter os metadados para aquele tamanho de foto. Se o tamanho pedido não estiver disponível, ainda pode obter um tamanho mais pequeno que o utilizador carregou e disponibilizou. Por exemplo, se o utilizador carregar uma fotografia com 504x504 píxeis, todos menos o tamanho 648x648 da fotografia estão disponíveis para transferência.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

As tabelas seguintes mostram as permissões ou permissões com menos privilégios necessárias para chamar esta API em cada tipo de recurso suportado. Siga as melhores práticas para pedir as permissões com menos privilégios. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Para recuperar a foto do perfil de um contato

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	Contacts.Read	Contacts.ReadWrite
Delegado (conta pessoal da Microsoft)	Contacts.Read	Contacts.ReadWrite
Aplicativo	Contacts.Read	Contacts.ReadWrite

Para recuperar a foto do perfil de um grupo

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	ProfilePhoto.Read.All	ProfilePhoto.ReadWrite.All, Group.Read.All, Group.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	ProfilePhoto.Read.All	ProfilePhoto.ReadWrite.All, Group.Read.All, Group.ReadWrite.All

Para obter a fotografia de perfil de uma equipa

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegada (conta corporativa ou de estudante)	Team.ReadBasic.All	TeamSettings.Read.All, TeamSettings.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Application	Team.ReadBasic.All	TeamSettings.Read.All, TeamSettings.ReadWrite.All

Para recuperar a foto do perfil de um usuário

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	ProfilePhoto.Read.All	ProfilePhoto.ReadWrite.All, User.Read, User.ReadBasic.All, User.Read.All, User.ReadWrite, User.ReadWrite.All
Delegado (conta pessoal da Microsoft)	User.Read	User.ReadWrite
Aplicativo	ProfilePhoto.Read.All	ProfilePhoto.ReadWrite.All, User.Read.All, User.ReadWrite.All

Observação

A obtenção da fotografia de um utilizador com a Microsoft Graph API não é atualmente suportada nos inquilinos do Azure AD B2C.

Solicitação HTTP

Obter a foto

GET /me/photo/$value
GET /users/{id | userPrincipalName}/photo/$value
GET /groups/{id}/photo/$value
GET /me/contacts/{id}/photo/$value
GET /users/{id | userPrincipalName}/contacts/{id}/photo/$value
GET /me/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
GET /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo/$value
GET /team/{id}/photo/$value

Obter os metadados da foto

GET /me/photo
GET /me/photos
GET /users/{id | userPrincipalName}/photo
GET /groups/{id}/photo
GET /me/contacts/{id}/photo
GET /users/{id | userPrincipalName}/contacts/{id}/photo
GET /me/contactfolders/{contactFolderId}/contacts/{id}/photo
GET /users/{id | userPrincipalName}/contactfolders/{contactFolderId}/contacts/{id}/photo
GET /team/{id}/photo

Obter os metadados de um tamanho de página específica.

GET /me/photos/{size}
GET /users/{id | userPrincipalName}/photos/{size}
GET /groups/{id}/photos/{size}

Parâmetros do caminho

Parâmetro	Tipo	Descrição
tamanho	Cadeia de caracteres	Um tamanho de foto. Os tamanhos suportados das fotos em HD do Microsoft 365 são os seguintes: 48x48, 64x64, 96x96, 120x120, 240x240, 360x360, 432x432, 504x504 e 648x648. As fotografias podem ter qualquer dimensão se estiverem armazenadas no ID do Microsoft Entra.

Parâmetros de consulta opcionais

Este método dá suporte a Parâmetros de consulta OData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome	Tipo	Descrição
Autorização	string	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Resposta para obter a foto

Se for bem-sucedido, este método retornará um código de resposta 200 OK e dados binários da foto solicitada. Se não existirem fotos, a operação retornará 404 Not Found.

Resposta para obter os metadados da foto

Se bem-sucedido, este método retorna o código de resposta 200 OK e o objeto profilePhoto no corpo da resposta.

Exemplos

Exemplo 1: Obter a foto do usuário conectado com o maior tamanho disponível

Solicitação

GET https://graph.microsoft.com/v1.0/me/photo/$value


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Photo.Content.GetAsync();



mgc users photo content get --user-id {user-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Photo().Value().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.me().photo().content().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/me/photo/$value')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->me()->photo()->content()->get()->wait();


Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserPhotoContent -UserId $userId -OutFile $outFileId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.me.photo.content.get()

Resposta

Contém os dados binários da foto solicitada. O código de resposta HTTP é 200.

HTTP/1.1 200 OK

Exemplo 2: Obtenha foto 48 x 48 para usuário conectado

Solicitação

GET https://graph.microsoft.com/v1.0/me/photos/48x48/$value
Content-Type: image/jpg


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Me.Photos["{profilePhoto-id}"].Content.GetAsync();



mgc users photos content get --user-id {user-id} --profile-photo-id {profilePhoto-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Me().Photos().ByProfilePhotoId("profilePhoto-id").Value().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.me().photos().byProfilePhotoId("{profilePhoto-id}").content().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/me/photos/48x48/$value')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->me()->photos()->byProfilePhotoId('profilePhoto-id')->content()->get()->wait();

Snippet not available


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.me.photos.by_profile_photo_id('profilePhoto-id').content.get()

Observação

Para garantir um tamanho fixo para a fotografia de saída, utilize o ponto final dedicado para fotografias (/fotografias) com tamanhos fixos em vez de depender do ponto final de fotografia predefinido (/foto), que fornece a maior fotografia disponível.

Resposta

Contém os dados binários da foto de 48x48 solicitada. O código de resposta HTTP é 200.

HTTP/1.1 200 OK

Exemplo 3: Esta solicitação obtém os metadados da foto do usuário conectado.

Solicitação

GET https://graph.microsoft.com/v1.0/me/photo


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Photo.GetAsync();



mgc users photo get --user-id {user-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
photo, err := graphClient.Me().Photo().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ProfilePhoto result = graphClient.me().photo().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let profilePhoto = await client.api('/me/photo')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->photo()->get()->wait();


Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserPhoto -UserId $userId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.photo.get()

Resposta

Os dados de resposta a seguir mostram os metadados da foto.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://graph.microsoft.com/v1.0/users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "@odata.mediaEtag": "\"BA09D118\"",
    "id": "240x240",
    "width": 240,
    "height": 240
}

Os dados de resposta a seguir mostram o conteúdo de uma resposta quando uma foto ainda não foi carregada para o usuário.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Me/photo/$entity",
    "@odata.id": "https://graph.microsoft.com/v1.0/users('ddfcd489-628b-7d04-b48b-20075df800e5@1717622f-1d94-c0d4-9d74-f907ad6677b4')/photo",
    "@odata.mediaContentType": "image/gif",
    "@odata.mediaEtag": "",
    "id": "1x1",
    "width": 1,
    "height": 1
}

Exemplo 4: Obter os metadados da fotografia de equipa

Solicitação

O exemplo seguinte mostra um pedido para obter os metadados da fotografia de equipa.

GET https://graph.microsoft.com/v1.0/teams/172b0cce-e65d-44ce-9a49-91d9f2e8491e/photo


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Teams["{team-id}"].Photo.GetAsync();



mgc teams photo get --team-id {team-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
photo, err := graphClient.Teams().ByTeamId("team-id").Photo().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

ProfilePhoto result = graphClient.teams().byTeamId("{team-id}").photo().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let profilePhoto = await client.api('/teams/172b0cce-e65d-44ce-9a49-91d9f2e8491e/photo')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->teams()->byTeamId('team-id')->photo()->get()->wait();


Import-Module Microsoft.Graph.Teams

Get-MgTeamPhoto -TeamId $teamId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.teams.by_team_id('team-id').photo.get()

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('172b0cce-e65d-44ce-9a49-91d9f2e8491e')/photo/$entity",
    "@odata.id": "https://graph.microsoft.com/v1.0/teams('172b0cce-e65d-44ce-9a49-91d9f2e8491e')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "@odata.mediaEtag": "\"BA09D118\"",
    "id": "240X240",
    "width": 240,
    "height": 240
}

Exemplo 5: Obter os dados binários da fotografia de equipa

O exemplo seguinte mostra um pedido para obter os dados binários da fotografia de equipa.

Solicitação

GET https://graph.microsoft.com/v1.0/teams/172b0cce-e65d-44ce-9a49-91d9f2e8491e/photo/$value


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Teams["{team-id}"].Photo.Content.GetAsync();



mgc teams photo content get --team-id {team-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Teams().ByTeamId("team-id").Photo().Value().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.teams().byTeamId("{team-id}").photo().content().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let stream = await client.api('/teams/172b0cce-e65d-44ce-9a49-91d9f2e8491e/photo/$value')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->teams()->byTeamId('team-id')->photo()->content()->get()->wait();


Import-Module Microsoft.Graph.Teams

Get-MgTeamPhotoContent -TeamId $teamId -OutFile $outFileId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.teams.by_team_id('team-id').photo.content.get()

Resposta

Contém os dados binários da foto solicitada. O código de resposta HTTP é 200.

HTTP/1.1 200 OK

Usando os dados binários da foto solicitada

Quando utiliza o /photo/$value ponto final para obter os dados binários de uma fotografia de perfil, tem de converter os dados numa cadeia base 64 para adicioná-la como um anexo de e-mail. Veja aqui um exemplo no JavaScript de como criar uma matriz que você pode passar como o valor do parâmetro Attachments de uma Mensagem do Outlook.

const attachments = [{
  '@odata.type': '#microsoft.graph.fileAttachment',
  ContentBytes: file.toString('base64'),
  Name: 'mypic.jpg'
}];

Para obter detalhes sobre a implementação, veja o Exemplo do Microsoft Graph Connect para Node.js.

Se quiser exibir a imagem em uma página da Web, crie um objeto de memória usando a imagem e torne esse objeto a fonte de um elemento de imagem. O exemplo de JavaScript seguinte mostra esta operação.

const url = window.URL || window.webkitURL;
const blobUrl = url.createObjectURL(image.data);
document.getElementById(imageElement).setAttribute("src", blobUrl);

Partilhar via

Get profilePhoto

Permissões

Para recuperar a foto do perfil de um contato

Para recuperar a foto do perfil de um grupo

Para obter a fotografia de perfil de uma equipa

Para recuperar a foto do perfil de um usuário

Solicitação HTTP

Obter a foto

Obter os metadados da foto

Obter os metadados de um tamanho de página específica.

Parâmetros do caminho

Parâmetros de consulta opcionais

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Resposta para obter a foto

Resposta para obter os metadados da foto

Exemplos

Exemplo 1: Obter a foto do usuário conectado com o maior tamanho disponível

Solicitação

Resposta

Exemplo 2: Obtenha foto 48 x 48 para usuário conectado

Solicitação

Resposta

Exemplo 3: Esta solicitação obtém os metadados da foto do usuário conectado.

Solicitação

Resposta

Exemplo 4: Obter os metadados da fotografia de equipa

Solicitação

Resposta

Exemplo 5: Obter os dados binários da fotografia de equipa

Solicitação

Resposta

Usando os dados binários da foto solicitada

Comentários

Recursos adicionais