Partilhar via

Adicionar ou remover atributos personalizados numa card de perfil com o perfil card API

  • Artigo

O perfil card no Microsoft 365 mostra informações sobre um utilizador numa organização. As informações apresentadas no perfil card são armazenadas e mantidas pela organização, por exemplo, cargo ou localização do Office.

As organizações podem utilizar o recurso profileCardProperty para mostrar mais propriedades de Microsoft Entra ID no card de perfil de um utilizador numa organização ao:

  • Tornar mais atributos visíveis
  • Adicionando atributos personalizados

São apresentadas mais propriedades na secção Contacto do perfil card no Microsoft 365.

Também pode remover atributos personalizados dos cartões de perfil da organização.

Observação

As propriedades de card de perfil correspondem a atributos no Microsoft Entra ID. Adicionar um atributo como perfilCardProperty à coleção profileCardProperties para uma organização configura cartões de perfil para apresentar o valor do atributo. Eliminar o perfilCardProperty da coleção não elimina o atributo de Microsoft Entra ID; elimina a configuração para que os cartões de perfil deixem de apresentar o valor do atributo.

Observação

O perfil card personalizações de propriedades descritas neste artigo não se aplicam a aplicações Win32, como clientes de ambiente de trabalho do Outlook e do Office. Para saber como personalizar o perfil card propriedades em aplicações Win32 para a sua organização, consulte Personalizar o perfil card em aplicações Win32 com chaves de registo.

As APIs card propriedades do perfil estão disponíveis nas seguintes implementações na cloud nacionais.

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

Observação

As operações no recurso profileCardProperty que utilizam permissões delegadas requerem que o utilizador com sessão iniciada tenha uma função de Administrador Inquilino.

Tornar outros atributos visíveis no perfil card

Pode tornar os seguintes atributos de Microsoft Entra ID visíveis nos cartões de perfil dos utilizadores. Estes atributos não são sensíveis a maiúsculas e minúsculas:

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

A tabela seguinte mostra como os atributos Microsoft Entra ID correspondem às propriedades da entidade de utilizador do Microsoft Graph.

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

Pode adicionar qualquer um destes atributos ao perfil card ao configurar as definições de administrador de pessoas e ao adicionar o atributo como propriedade directoryPropertyName de um perfilCardProperty no Microsoft Graph. Quando torna estes atributos visíveis, tem de utilizar os nomes das propriedades para en-us. Não é necessário adicionar valores localizados. Estas propriedades são apresentadas automaticamente nas definições de idioma que o utilizador especifica para o Microsoft 365.

Nota: Os valores das propriedades da entidade do utilizador contêm informações de utilizador armazenadas e geridas pela organização.

Importante

Ao adicionar um atributo a um perfil card, a adição demora até 24 horas a ser apresentada.

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

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"
}

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

Se bem-sucedido, esse método retorna um 201 OK código de resposta e um objeto profileCardProperty no corpo da resposta. O valor do Alias atributo é apresentado no perfil de um utilizador card.

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

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

Adicionar um atributo personalizado ao card de perfil

Pode adicionar qualquer um dos 15 atributos de extensão personalizada Microsoft Entra ID aos cartões de perfil dos utilizadores ao configurar as definições da sua organização e ao adicionar o valor correspondente como perfilCardProperty 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 utilizadas para procurar pessoas em aplicações e serviços Microsoft.

A tabela seguinte mostra como os Microsoft Entra ID nomes de atributos de extensão personalizada correspondem aos valores suportados para a propriedade directoryPropertyName do recurso profileCardProperty. Estes Microsoft Entra ID nomes de atributos de extensão personalizada não são sensíveis a maiúsculas e minúsculas:

Microsoft Entra ID atributo de extensão personalizada 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

São adicionados atributos de card de perfis personalizados a todos os utilizadores na organização, o que requer as precauções necessárias para evitar a exposição acidental de dados confidenciais.

Exemplo

O exemplo seguinte adiciona o primeiro atributo Microsoft Entra ID extensão personalizada ao card de perfil, utilizando o nome a apresentar Centro de custos. Para os utilizadores que definem as definições de idioma para alemão, o nome a apresentar é Kostenstelle.

Solicitação

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

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

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

Se um idioma não for suportado, o nome da propriedade é apresentado com o valor predefinido.

Se bem-sucedido, este método retorna um 201 OK código de resposta e um objeto profileCardProperty no corpo da resposta. Neste exemplo, pode assumir que o perfil card apresenta Kostenstelle para todos os utilizadores que definirem as definições de idioma para alemão no perfil card. Para todos os outros utilizadores, o Centro de Custos é apresentado no perfil card.

Resposta

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

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

Remover um atributo personalizado do card de perfil

Seguindo o mesmo mapeamento entre Microsoft Entra ID atributos de extensão personalizados e card atributos personalizados (como CustomAttribute1) conforme descrito na secção anterior Adicionar um atributo personalizado, pode remover um atributo personalizado com a operação de eliminação, conforme mostrado no exemplo seguinte.

Exemplo

O exemplo seguinte remove o atributo CustomAttribute5 personalizado das definiçõ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

Nota: 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 de card de perfil com o PowerShell

Pode utilizar o SDK do PowerShell do Microsoft Graph para configurar o perfil card propriedades na sua organização.

Pré-requisitos

Confirmar as definições atuais

Para obter o perfil card configuração de propriedades de uma organização, utilize o seguinte comando.

   Get-MgAdminPeopleProfileCardProperty

Para obter um perfil específico card configuração de propriedades numa organização, utilize o seguinte comando.

   Get-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Observação

Os comandos get requerem 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 de card de perfil na sua organização

Pode utilizar o módulo do PowerShell do Microsoft Graph para disponibilizar os atributos Microsoft Entra ID e os 15 atributos de extensão de Microsoft Entra ID personalizáveis na 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"

Utilize o seguinte comando.

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

New-MgAdminPeopleProfileCardProperty -BodyParameter $params

Atualizar as propriedades do perfil card na sua organização

Pode utilizar o módulo do PowerShell do Microsoft Graph para atualizar o perfil card propriedades disponíveis na sua organização.

Observação

O comando update 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"

Utilize o seguinte comando, onde substitui $profileCardPropertyId pelo ID da propriedade a atualizar.

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

Update-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId -BodyParameter $params

Remover propriedades de card de perfil na sua organização

Pode utilizar o módulo do PowerShell do Microsoft Graph para remover o perfil card propriedades da sua organização.

Observação

O comando remover 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"

Utilize o seguinte comando, onde substitui $profileCardPropertyId pelo ID da propriedade a ser removida.

 Remove-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Conteúdo relacionado