Adicionar ou remover atributos personalizados em um card de perfil usando a API do card de perfil

O profile card no Microsoft 365 mostra informações sobre um usuário em uma organização. As informações mostradas no card de perfil são armazenadas e mantidas pela organização, por exemplo, cargo ou local do escritório.

As organizações podem usar o recurso profileCardProperty para mostrar mais propriedades de Microsoft Entra ID no card de perfil para um usuário em uma organização:

• Tornando mais atributos visíveis
• Adicionando atributos personalizados

Mais propriedades são exibidas na seção Contato do card de perfil no Microsoft 365.

Você também pode remover atributos personalizados de cartões de perfil da organização.

Observação

As propriedades do card de perfil correspondem aos atributos no Microsoft Entra ID. Adicionar um atributo como um profileCardProperty à coleção profileCardProperties de uma organização configura cartões de perfil para exibir o valor do atributo. Excluir o profileCardProperty da coleção não exclui o atributo do Microsoft Entra ID; exclui a configuração para que os cartões de perfil não exibam mais o valor do atributo.

Observação

As personalizações de propriedades do card de perfil descritas neste artigo não se aplicam a aplicativos Win32, como clientes de área de trabalho do Outlook e do Office. Para saber como personalizar as propriedades do card de perfil em aplicativos Win32 para sua organização, consulte Personalizar o card de perfil em aplicativos Win32 usando chaves do Registro.

As APIs de propriedades do card de perfil estão disponíveis nas seguintes implantações de nuvem nacional.

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

Observação

As operações no recurso profileCardProperty que usam permissões delegadas exigem que o usuário conectado tenha uma função de Administrador de Locatários.

Tornar outros atributos visíveis no card de perfil

Você pode tornar os seguintes atributos do Microsoft Entra ID visíveis nos cartões de perfil dos usuários. Esses atributos não diferenciam maiúsculas de minúsculas:

• UserPrincipalName
• Fax
• StreetAddress
• PostalCode
• StateOrProvince
• Alias

A tabela a seguir mostra como os atributos do Microsoft Entra ID correspondem às propriedades da entidade de usuário do Microsoft Graph.

Atributo do Microsoft Entra ID	Propriedade da entidade User
UserPrincipalName	userPrincipalName
Fax	faxNumber
StreetAddress	streetAddress
PostalCode	postalCode
StateOrProvince	estado
Alias	mailNickname

Você pode adicionar qualquer um desses atributos ao profile card definindo as configurações de administrador de pessoas e adicionando o atributo como a propriedade directoryPropertyName de um profileCardProperty no Microsoft Graph. Ao tornar esses atributos visíveis, você deve usar os nomes de propriedade para en-us. Não é necessário adicionar valores localizados. Essas propriedades são mostradas automaticamente nas configurações de idioma que o usuário especifica para o Microsoft 365.

Observação: Os valores de propriedade de entidade de usuário contêm informações de usuário armazenadas e gerenciadas pela organização.

Importante

Ao adicionar um atributo a um profile card, leva até 24 horas para que a adição seja exibida.

Configurar propriedades do card de perfil usando a API REST do Microsoft Graph

Use as anotações e as propriedades directoryPropertyName em profileCardProperty para configurar as propriedades do card de perfil. Você também pode usar a propriedade isVisible para indicar se a propriedade de diretório determinada deve ser mostrada no perfil de um usuário card.

Exemplo

O exemplo a seguir exibe o Alias atributo no cartão de perfil.

POST https://graph.microsoft.com/v1.0/admin/people/profileCardProperties
Content-Type: application/json

{
  "directoryPropertyName": "Alias"
}

Observação: O /organization/{organizationId}/settings caminho foi preterido na experiência beta. Daqui em diante, use o caminho /admin/people.

Se bem-sucedido, este método retorna um 201 Created código de resposta e um objeto profileCardProperty no corpo da resposta. O valor do Alias atributo é exibido no card de perfil de um usuário.

HTTP/1.1 201 Created
Content-type: application/json

{
  "annotations": [],
  "directoryPropertyName": "Alias",
  "isVisible": true
}

Adicionar um atributo personalizado ao profile card

Você pode adicionar qualquer um dos 15 atributos de extensão personalizada do Microsoft Entra ID aos cartões de perfil dos usuários definindo as configurações da sua organização e adicionando o valor correspondente como um profileCardProperty no Microsoft Graph. Você pode adicionar um recurso profileCardProperty por vez.

São necessárias até 24 horas para que as alterações sejam mostradas em cartões de perfil.

As propriedades personalizadas não são pesquisáveis e não podem ser usadas para pesquisar pessoas em aplicativos e serviços da Microsoft.

A tabela a seguir mostra como os nomes de atributo de extensão personalizada do Microsoft Entra ID correspondem aos valores com suporte para a propriedade directoryPropertyName do recurso profileCardProperty. Esses nomes de atributo de extensão personalizada do Microsoft Entra ID não diferenciam maiúsculas de minúsculas:

Atributo de extensão personalizada do Microsoft Entra ID	Valor para especificar como directoryPropertyName
extensionAttribute1	CustomAttribute1
extensionAttribute2	CustomAttribute2
extensionAttribute3	CustomAttribute3
extensionAttribute4	CustomAttribute4
extensionAttribute5	CustomAttribute5
extensionAttribute6	CustomAttribute6
extensionAttribute7	CustomAttribute7
extensionAttribute8	CustomAttribute8
extensionAttribute9	CustomAttribute9
extensionAttribute10	CustomAttribute10
extensionAttribute12	CustomAttribute12
extensionAttribute11	CustomAttribute11
extensionAttribute13	CustomAttribute13
extensionAttribute14	CustomAttribute14
extensionAttribute15	CustomAttribute15

Importante

Os atributos de card de perfil personalizados são adicionados para todos os usuários da organização, exigindo as precauções necessárias para evitar a exposição acidental de dados confidenciais.

Exemplo

O exemplo a seguir adiciona o primeiro atributo de extensão personalizada do Microsoft Entra ID ao profile card, usando o nome de exibição Centro de custo. Para usuários que definiram suas configurações de idioma como alemão, o nome de exibição é Kostenstelle.

Solicitação

POST https://graph.microsoft.com/v1.0/admin/people/profileCardProperties
Content-Type: application/json

{
  "annotations": [
    {
      "displayName": "Cost center",
      "localizations": [
        {
          "languageTag": "de",
          "displayName": "Kostenstelle"
        }
      ]
    }
  ],
  "directoryPropertyName": "CustomAttribute1",
  "isVisible": true
}

Observação: O /organization/{organizationId}/settings caminho foi preterido na experiência beta. Daqui em diante, use o caminho /admin/people.

Se não houver suporte para um idioma, o nome da propriedade será mostrado com o valor padrão.

Se bem-sucedido, este método retorna um 201 Created código de resposta e um objeto profileCardProperty no corpo da resposta. Neste exemplo, você pode supor que o profile card exibe Kostenstelle para todos os usuários que definiram suas configurações de idioma como alemão no profile card. Para todos os outros usuários, o Centro de custo é exibido no card de perfil.

Resposta

HTTP/1.1 201 Created
Content-type: application/json

{
  "annotations": [
    {
      "displayName": "Cost center",
      "localizations": [
        {
          "languageTag": "de",
          "displayName": "Kostenstelle"
        }
      ]
    }
  ],
  "directoryPropertyName": "CustomAttribute1",
  "isVisible": true
}

Remover um atributo personalizado do perfil do card

Seguindo o mesmo mapeamento entre os atributos de extensão personalizada do Microsoft Entra ID e os atributos personalizados do card de perfil (como CustomAttribute1) conforme descrito na seção anterior Adicionando um atributo personalizado, você pode remover um atributo personalizado usando a operação de exclusão, conforme mostrado no exemplo a seguir.

Exemplo

O exemplo a seguir remove o atributo CustomAttribute5 personalizado das configurações da organização. Se tiver êxito, este método retornará um código de resposta 204 No Content.

Solicitação

DELETE https://graph.microsoft.com/v1.0/admin/people/profileCardProperties/CustomAttribute5

Observação: O /organization/{organizationId}/settings caminho foi preterido na experiência beta. Daqui em diante, use o caminho /admin/people.

Resposta

HTTP/1.1 204 No Content

Configurar propriedades do card de perfil usando o PowerShell

Você pode usar o SDK do Microsoft Graph PowerShell para configurar as propriedades do card de perfil em sua organização.

Pré-requisitos

• Módulo do PowerShell - Instala a versão do módulo 1.24.0 ou superior.
• .NET Framework - Instale o .NET Framework 4.7.2 ou uma versão superior.

Confirme as configurações atuais

Para obter a configuração das propriedades do card de perfil de uma organização, use o comando a seguir.

   Get-MgAdminPeopleProfileCardProperty

Para obter uma configuração de propriedade de card de perfil específica em uma organização, use o comando a seguir.

   Get-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Observação

Os comandos get exigem a PeopleSettings.Read.All permissão. Para criar uma sessão do Microsoft Graph com um escopo específico necessário, use o seguinte comando e concorde com as permissões solicitadas.

   Connect-MgGraph -Scopes "PeopleSettings.Read.All"

Adicionar propriedades do card de perfil em sua organização

Você pode usar o módulo Microsoft Graph PowerShell para disponibilizar os atributos do Microsoft Entra ID e os 15 atributos personalizáveis da extensão do Microsoft Entra ID em sua organização.

Observação

O novo comando requer a PeopleSettings.ReadWrite.All permissão. Para criar uma sessão do Microsoft Graph com um escopo específico necessário, use o seguinte comando e concorde com as permissões solicitadas.

   Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

Use o comando a seguir.

$params = @{
	directoryPropertyName = "CustomAttribute1"
	annotations = @(
		@{
			displayName = "Cost Center"
			localizations = @(
				@{
					languageTag = "ru"
					displayName = "центр затрат"
				}
			)
		}
	)
}

New-MgAdminPeopleProfileCardProperty -BodyParameter $params

Atualizar as propriedades do card de perfil em sua organização

Você pode usar o módulo Microsoft Graph PowerShell para atualizar as propriedades do card de perfil disponíveis em sua organização.

Observação

O comando de atualização requer a PeopleSettings.ReadWrite.All permissão. Para criar uma sessão do Microsoft Graph com um escopo específico necessário, use o seguinte comando e concorde com as permissões solicitadas.

   Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

Use o comando a seguir, onde você substitui $profileCardPropertyId pela ID da propriedade a ser atualizada.

$params = @{
	annotations = @(
		@{
      displayName = "Cost Center"
			localizations = @(
				@{
					languageTag = "no"
					displayName = "Kostnads Senter"
				}
			)
		}
	)
}

Update-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId -BodyParameter $params

Remover propriedades do card de perfil em sua organização

Você pode usar o módulo Microsoft Graph PowerShell para remover propriedades de card de perfil de sua organização.

Observação

O comando remove requer a PeopleSettings.ReadWrite.All permissão. Para criar uma sessão do Microsoft Graph com um escopo específico necessário, use o seguinte comando e concorde com as permissões solicitadas.

   Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"

Use o comando a seguir, onde você substitui $profileCardPropertyId pela ID da propriedade a ser removida.

 Remove-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Conteúdo relacionado

• Tipo de recurso onPremisesExtensionAttributes
• Tipo de recurso de usuário
• Explorador do Graph
• Obter profileCardProperty
• Solicitações de assunto de dados do Azure para o GDPR e o CCPA
• Em quais idiomas o card de perfil está disponível?