Ajouter ou supprimer des attributs personnalisés sur un carte de profil à l’aide de l’API de carte de profil

  • Article

Le profil carte dans Microsoft 365 affiche des informations sur un utilisateur dans un organization. Les informations affichées sur le profil carte sont stockées et gérées par le organization, par exemple, Poste ou Emplacement du bureau.

Les organisations peuvent utiliser la ressource profileCardProperty pour afficher davantage de propriétés à partir de Microsoft Entra ID sur la carte de profil d’un utilisateur dans un organization en :

  • Rendre plus d’attributs visibles
  • Ajout d’attributs personnalisés

D’autres propriétés s’affichent dans la section Contact du profil carte dans Microsoft 365.

Vous pouvez également supprimer des attributs personnalisés des cartes de profil du organization.

Remarque

Les propriétés de carte de profil correspondent aux attributs dans Microsoft Entra ID. L’ajout d’un attribut en tant que profileCardProperty à la collection profileCardProperties pour un organization configure les cartes de profil pour afficher la valeur de l’attribut. La suppression de profileCardProperty de la collection ne supprime pas l’attribut de Microsoft Entra ID ; elle supprime la configuration afin que les cartes de profil n’affichent plus la valeur de l’attribut.

Les API de propriétés de carte de profil sont disponibles dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ✅

Remarque

Les opérations sur la ressource profileCardProperty qui utilisent des autorisations déléguées nécessitent que l’utilisateur connecté ait un rôle Administrateur client ou Administrateur général.

Rendre d’autres attributs visibles sur le profil carte

Vous pouvez rendre les attributs suivants à partir de Microsoft Entra ID visibles sur les cartes de profil des utilisateurs. Ces attributs ne respectent pas la casse :

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

Le tableau suivant montre comment les attributs Microsoft Entra ID correspondent aux propriétés de l’entité utilisateur Microsoft Graph.

attribut Microsoft Entra ID Propriété de l’entité utilisateur
UserPrincipalName userPrincipalName
Fax faxNumber
StreetAddress streetAddress
PostalCode postalCode
StateOrProvince état
Alias mailNickname

Vous pouvez ajouter l’un de ces attributs au profil carte en configurant vos paramètres d’administration de personnes et en ajoutant l’attribut en tant que propriété directoryPropertyName d’un profileCardProperty dans Microsoft Graph. Lorsque vous rendez ces attributs visibles, vous devez utiliser les noms de propriété pour en-us. Vous n’êtes pas obligé d’ajouter des valeurs localisées. Ces propriétés sont automatiquement affichées dans les paramètres de langue que l’utilisateur spécifie pour Microsoft 365.

Note: Les valeurs de propriété d’entité utilisateur contiennent des informations utilisateur stockées et gérées par le organization.

Importante

Lors de l’ajout d’un attribut à un profil carte, l’affichage de l’ajout prend jusqu’à 24 heures.

Configurer les propriétés de carte de profil à l’aide de l’API REST Microsoft Graph

Exemple

L’exemple suivant affiche l’attribut Alias sur la carte de visite :

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

{
  "directoryPropertyName": "Alias"
}

Note: Le /organization/{organizationId}/settings chemin d’accès est déconseillé dans l’expérience bêta. À l’avenir, utilisez le chemin d’accès /admin/people.

Si elle réussit, la réponse renvoie un code de réponse 201 OK et un objet profileCardProperty dans le corps de la réponse. La valeur de l’attribut Alias s’affiche sur le profil d’un utilisateur carte.

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

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

Ajouter un attribut personnalisé au profil carte

Vous pouvez ajouter l’un des 15 attributs d’extension personnalisés Microsoft Entra ID aux cartes de profil des utilisateurs en configurant vos paramètres de organization et en ajoutant la valeur correspondante en tant que profileCardProperty dans Microsoft Graph. Vous pouvez ajouter une ressource profileCardProperty à la fois.

L’affichage des modifications sur les cartes de profil prend jusqu’à 24 heures.

Les propriétés personnalisées ne peuvent pas faire l’objet d’une recherche et ne peuvent pas être utilisées pour rechercher des personnes dans les applications et services Microsoft.

Le tableau suivant montre comment les Microsoft Entra ID noms d’attributs d’extension personnalisés correspondent aux valeurs prises en charge pour la propriété directoryPropertyName de la ressource profileCardProperty. Ces Microsoft Entra ID noms d’attributs d’extension personnalisés ne respectent pas la casse :

Microsoft Entra ID attribut d’extension personnalisé Valeur à spécifier comme 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

Les attributs de carte de profil personnalisé sont ajoutés pour tous les utilisateurs du organization, ce qui nécessite des précautions nécessaires pour empêcher l’exposition accidentelle de données sensibles.

Exemple

L’exemple suivant ajoute le premier attribut d’extension personnalisée Microsoft Entra ID au carte de profil, en utilisant le nom complet Centre de coûts. Pour les utilisateurs qui définissent leurs paramètres linguistiques sur l’allemand, le nom d’affichage est Kostenstelle.

Demande

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

Note: Le /organization/{organizationId}/settings chemin d’accès est déconseillé dans l’expérience bêta. À l’avenir, utilisez le chemin d’accès /admin/people.

Si une langue n’est pas prise en charge, le nom de la propriété est affiché avec la valeur par défaut.

Si elle réussit, la réponse renvoie un code de réponse 201 OK et un objet profileCardProperty dans le corps de la réponse. Dans cet exemple, vous pouvez supposer que le profil carte affiche Kostenstelle pour tous les utilisateurs qui définissent leurs paramètres linguistiques sur l’allemand sur le profil carte. Pour tous les autres utilisateurs, le Centre de coûts s’affiche sur le profil carte.

Réponse

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

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

Supprimer un attribut personnalisé du profil carte

En suivant le même mappage entre Microsoft Entra ID attributs d’extension personnalisés et les attributs personnalisés de profil carte (tels que CustomAttribute1) comme décrit dans la section précédente Ajout d’un attribut personnalisé, vous pouvez supprimer un attribut personnalisé à l’aide de l’opération de suppression, comme illustré dans l’exemple suivant.

Exemple

L’exemple suivant supprime l’attribut CustomAttribute5 personnalisé des paramètres organization. Si elle réussit, cette méthode renvoie un code de réponse 204 No Content.

Demande

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

Note: Le /organization/{organizationId}/settings chemin d’accès est déconseillé dans l’expérience bêta. À l’avenir, utilisez le chemin d’accès /admin/people.

Réponse

HTTP/1.1 204 No Content

Configurer les propriétés de carte de profil à l’aide de PowerShell

Vous pouvez utiliser le Kit de développement logiciel (SDK) Microsoft Graph PowerShell pour configurer les propriétés de carte de profil dans votre organization.

Configuration requise

Confirmer vos paramètres actuels

Pour obtenir la configuration des propriétés de carte de profil pour un organization, utilisez la commande suivante.

   Get-MgAdminPeopleProfileCardProperty

Pour obtenir un profil spécifique carte configuration de propriété dans un organization, utilisez la commande suivante.

   Get-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Remarque

Les commandes get nécessitent l’autorisation PeopleSettings.Read.All . Pour créer une session Microsoft Graph avec une étendue requise spécifique, utilisez la commande et l’autorisation suivantes pour demander des autorisations.

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

Ajouter des propriétés de carte de profil dans votre organization

Vous pouvez utiliser le module Microsoft Graph PowerShell pour rendre les attributs Microsoft Entra ID et les 15 attributs d’extension Microsoft Entra ID personnalisables disponibles dans votre organization.

Remarque

La nouvelle commande nécessite l’autorisation PeopleSettings.ReadWrite.All . Pour créer une session Microsoft Graph avec une étendue requise spécifique, utilisez la commande et l’autorisation suivantes pour demander des autorisations.

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

Utilisez la commande suivante.

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

New-MgAdminPeopleProfileCardProperty -BodyParameter $params

Mettre à jour les propriétés de carte de profil dans votre organization

Vous pouvez utiliser le module Microsoft Graph PowerShell pour mettre à jour les propriétés de profil carte disponibles dans votre organization.

Remarque

La commande update nécessite l’autorisation PeopleSettings.ReadWrite.All . Pour créer une session Microsoft Graph avec une étendue requise spécifique, utilisez la commande et l’autorisation suivantes pour demander des autorisations.

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

Utilisez la commande suivante, où vous remplacez par $profileCardPropertyId l’ID de la propriété à mettre à jour.

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

Update-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId -BodyParameter $params

Supprimer les propriétés de carte de profil dans votre organization

Vous pouvez utiliser le module Microsoft Graph PowerShell pour supprimer les propriétés de carte de profil de votre organization.

Remarque

La commande remove nécessite l’autorisation PeopleSettings.ReadWrite.All . Pour créer une session Microsoft Graph avec une étendue requise spécifique, utilisez la commande et l’autorisation suivantes pour demander des autorisations.

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

Utilisez la commande suivante, où vous remplacez par $profileCardPropertyId l’ID de la propriété à supprimer.

 Remove-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Contenu connexe