Редактиране

Споделяне чрез

Add or remove custom attributes on a profile card using the profile card API

  • Статия

The profile card in Microsoft 365 shows information about a user in an organization. The information shown on the profile card is stored and maintained by the organization, for example, Job title or Office location.

Organizations can use the profileCardProperty resource to show more properties from Microsoft Entra ID on the profile card for a user in an organization by:

  • Making more attributes visible
  • Adding custom attributes

More properties display in the Contact section of the profile card in Microsoft 365.

You can also remove custom attributes from profile cards of the organization.

Note

Profile card properties correspond to attributes in Microsoft Entra ID. Adding an attribute as a profileCardProperty to the profileCardProperties collection for an organization configures profile cards to display the attribute value. Deleting the profileCardProperty from the collection doesn’t delete the attribute from Microsoft Entra ID; it deletes the configuration so that profile cards no longer display the attribute value.

Note

The profile card properties customizations described in this article don't apply to Win32 applications such as Outlook and Office desktop clients. To learn how to customize profile card properties in Win32 applications for your organization, see Customize the profile card in Win32 apps using registry keys.

Profile card properties APIs are available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ✅

Note

Operations on the profileCardProperty resource that use delegated permissions require the signed-in user to have a Tenant Administrator role.

Make other attributes visible on the profile card

You can make the following attributes from Microsoft Entra ID visible on the users' profile cards. These attributes aren't case-sensitive:

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

The following table shows how the Microsoft Entra ID attributes correspond with properties of the Microsoft Graph user entity.

Microsoft Entra ID attribute User entity property
UserPrincipalName userPrincipalName
Fax faxNumber
StreetAddress streetAddress
PostalCode postalCode
StateOrProvince state
Alias mailNickname

You can add any of these attributes to the profile card by configuring your people admin settings and adding the attribute as the directoryPropertyName property of a profileCardProperty in Microsoft Graph. When you make these attributes visible, you must use the property names for en-us. You don't have to add localized values. These properties are automatically shown in the language settings that the user specifies for Microsoft 365.

Note: User entity property values contain user information stored and managed by the organization.

Important

When adding an attribute to a profile card, it takes up to 24 hours for the addition to be displayed.

Configure profile card properties using the Microsoft Graph REST API

Example

The following example displays the Alias attribute on the profile card.

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

{
  "directoryPropertyName": "Alias"
}

Note: The /organization/{organizationId}/settings path is deprecated in the beta experience. Going forward, use the /admin/people path.

If successful, the response returns a 201 OK response code and a profileCardProperty object in the response body. The value for the Alias attribute is displayed on a user's profile card.

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

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

Add a custom attribute to the profile card

You can add any of the 15 Microsoft Entra ID custom extension attributes to users' profile cards by configuring your organization settings and adding the corresponding value as a profileCardProperty in Microsoft Graph. You can add one profileCardProperty resource at a time.

It takes up to 24 hours for the changes to show on profile cards.

Custom properties aren't searchable and can't be used to search for people across Microsoft apps and services.

The following table shows how the Microsoft Entra ID custom extension attribute names correspond to the supported values for the directoryPropertyName property of the profileCardProperty resource. These Microsoft Entra ID custom extension attribute names aren't case-sensitive:

Microsoft Entra ID custom extension attribute Value to specify as 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

Important

Custom profile card attributes are added for all users in the organization, requiring necessary precautions to prevent accidental exposure of sensitive data.

Example

The following example adds the first Microsoft Entra ID custom extension attribute to the profile card, using the display name Cost center. For users who set their language settings to German, the display name is Kostenstelle.

Request

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: The /organization/{organizationId}/settings path is deprecated in the beta experience. Going forward, use the /admin/people path.

If a language isn't supported, the property name is shown with the default value.

If successful, the response returns a 201 OK response code and a profileCardProperty object in the response body. In this example, you can assume that the profile card displays Kostenstelle for all users who set their language settings to German on the profile card. For all other users, Cost center is displayed on the profile card.

Response

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

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

Remove a custom attribute from the profile card

Following the same mapping between Microsoft Entra ID custom extension attributes and profile card custom attributes (such as CustomAttribute1) as described in the preceding section Adding a custom attribute, you can remove a custom attribute using the delete operation, as shown in the following example.

Example

The following example removes the custom attribute CustomAttribute5 from the organization settings. If successful, this method returns a 204 No Content response code.

Request

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

Note: The /organization/{organizationId}/settings path is deprecated in the beta experience. Going forward, use the /admin/people path.

Response

HTTP/1.1 204 No Content

Configure profile card properties using PowerShell

You can use the Microsoft Graph PowerShell SDK to configure profile card properties in your organization.

Prerequisites

Confirm your current settings

To get profile card properties configuration for an organization, use the following command.

   Get-MgAdminPeopleProfileCardProperty

To get a specific profile card property configuration in an organization, use the following command.

   Get-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Note

The get commands require the PeopleSettings.Read.All permission. To create a Microsoft Graph session with a specific required scope, use the following command and consent to requested permissions.

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

Add profile card properties in your organization

You can use the Microsoft Graph PowerShell module to make both Microsoft Entra ID attributes, and the 15 customizable Microsoft Entra ID extension attributes, available in your organization.

Note

The new command requires the PeopleSettings.ReadWrite.All permission. To create a Microsoft Graph session with a specific required scope, use the following command and consent to requested permissions.

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

Use the following command.

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

New-MgAdminPeopleProfileCardProperty -BodyParameter $params

Update profile card properties in your organization

You can use the Microsoft Graph PowerShell module to update profile card properties available in your organization.

Note

The update command requires the PeopleSettings.ReadWrite.All permission. To create a Microsoft Graph session with a specific required scope, use the following command and consent to requested permissions.

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

Use the following command, where you replace $profileCardPropertyId with the ID of the property to be updated.

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

Update-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId -BodyParameter $params

Remove profile card properties in your organization

You can use the Microsoft Graph PowerShell module to remove profile card properties from your organization.

Note

The remove command requires the PeopleSettings.ReadWrite.All permission. To create a Microsoft Graph session with a specific required scope, use the following command and consent to requested permissions.

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

Use the following command, where you replace $profileCardPropertyId with the ID of the property to be removed.

 Remove-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Related content