Добавление или удаление настраиваемых атрибутов в карточке профиля с помощью API карточки профиля

На карточке профиля в Microsoft 365 отображаются сведения о пользователе в организации. Информация, отображаемая на карточке профиля, хранится и обслуживается организацией, например должность илирасположение Office.

Организации могут использовать ресурс profileCardProperty для отображения дополнительных свойств из идентификатора Microsoft Entra в карточке профиля для пользователя в организации:

• Обеспечение видимости дополнительных атрибутов
• Добавление настраиваемых атрибутов

Дополнительные свойства отображаются в разделе Контакт карточки профиля в Microsoft 365.

Вы также можете удалить настраиваемые атрибуты из карточек профиля организации.

Примечание.

Свойства карточки профиля соответствуют атрибутам в идентификаторе Microsoft Entra. Добавление атрибута в качестве profileCardProperty в коллекцию profileCardProperties для организации настраивает карточки профиля для отображения значения атрибута. Удаление profileCardProperty из коллекции не приводит к удалению атрибута из идентификатора Microsoft Entra; он удаляет конфигурацию, чтобы карточки профиля больше не отображали значение атрибута.

Примечание.

Настройки свойств карточки профиля, описанные в этой статье, не применяются к приложениям Win32, таким как Outlook и классические клиенты Office. Сведения о настройке свойств карточки профиля в приложениях Win32 для организации см . в статье Настройка карточки профиля в приложениях Win32 с помощью разделов реестра.

API свойств карточки профиля доступны в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	✅

Примечание.

Для операций с ресурсом profileCardProperty , использующих делегированные разрешения, требуется, чтобы у пользователя, выполнившего вход, была роль администратора клиента или глобального администратора.

Сделайте другие атрибуты видимыми на карточке профиля

Вы можете сделать следующие атрибуты из идентификатора Microsoft Entra видимыми на карточках профиля пользователей. Эти атрибуты не чувствительны к регистру:

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

В следующей таблице показано, как атрибуты идентификатора Microsoft Entra соответствуют свойствам сущности пользователя Microsoft Graph.

Атрибут Идентификатора Microsoft Entra	Свойство объекта user
UserPrincipalName	userPrincipalName
Fax	faxNumber
StreetAddress	streetAddress
PostalCode	postalCode
StateOrProvince	state
Alias	mailNickname

Вы можете добавить любой из этих атрибутов в карточку профиля, настроив параметры администратора пользователей и добавив атрибут в качестве свойства directoryPropertyNameобъекта profileCardProperty в Microsoft Graph. При отображении этих атрибутов необходимо использовать имена свойств для en-us. Вам не требуется добавлять локализованные значения. Эти свойства автоматически отображаются в языковых параметрах, указанных пользователем для Microsoft 365.

Заметка: Значения свойств сущности пользователя содержат сведения о пользователе, хранящиеся и управляемые организацией.

Важно!

При добавлении атрибута в карточку профиля на отображение добавления требуется до 24 часов.

Настройка свойств карточки профиля с помощью REST API Microsoft Graph

Пример

В следующем примере в карточке профиля отображается атрибут Alias.

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

{
  "directoryPropertyName": "Alias"
}

Заметка:/organization/{organizationId}/settings Путь не рекомендуется использовать в бета-версии. В дальнейшем используйте путь /admin/people.

При успешном выполнении возвращается код отклика 201 OK и объект profileCardProperty в тексте отклика. Значение атрибута Alias отображается на карточке профиля пользователя.

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

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

Добавление пользовательского атрибута в карточку профиля

Вы можете добавить любой из 15 настраиваемых атрибутов расширения Microsoft Entra ID в карточки профиля пользователей, настроив параметры организации и добавив соответствующее значение в качестве profileCardProperty в Microsoft Graph. Вы можете добавить один ресурс profileCardProperty за один раз.

Отображение внесенных изменений в карточках профилей занимают до 24 часов.

Пользовательские свойства недоступны для поиска и не могут использоваться для поиска людей в приложениях и службах Майкрософт.

В следующей таблице показано, как имена настраиваемых атрибутов расширения Идентификатора Microsoft Entra соответствуют поддерживаемым значениям свойства directoryPropertyName ресурса profileCardProperty . Имена настраиваемых атрибутов расширения Идентификатора Microsoft Entra не чувствительны к регистру:

Атрибут пользовательского расширения Идентификатора Microsoft Entra	Значение, указываемое в качестве 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

Важно!

Настраиваемые атрибуты карточки профиля добавляются для всех пользователей в организации, что требует необходимых мер предосторожности для предотвращения случайного раскрытия конфиденциальных данных.

Пример

В следующем примере первый настраиваемый атрибут расширения Microsoft Entra ID добавляется в карточку профиля, используя отображаемое имя Центр затрат. Для пользователей, которые задают для своих языковых параметров значение немецкий, отображаемое имя — Kostenstelle.

Запрос

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

Заметка:/organization/{organizationId}/settings Путь не рекомендуется использовать в бета-версии. В дальнейшем используйте путь /admin/people.

Если язык не поддерживается, имя свойства отображается со значением по умолчанию.

При успешном выполнении возвращается код отклика 201 OK и объект profileCardProperty в тексте отклика. В этом примере можно предположить, что карточка профиля отображает Kostenstelle для всех пользователей, которые устанавливают для своих языковых параметров немецкий на карточке профиля. Для всех остальных пользователей на карточке профиля отображается центр затрат .

Отклик

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

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

Удаление пользовательского атрибута из карточки профиля

После того же сопоставления между настраиваемыми атрибутами расширения Microsoft Entra ID и настраиваемыми атрибутами карточки профиля (например CustomAttribute1, ), как описано в предыдущем разделе Добавление настраиваемого атрибута, можно удалить настраиваемый атрибут с помощью операции удаления , как показано в следующем примере.

Пример

В следующем примере пользовательский атрибут CustomAttribute5 удаляется из параметров организации. В случае успешного выполнения этот метод возвращает код отклика 204 No Content.

Запрос

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

Заметка:/organization/{organizationId}/settings Путь не рекомендуется использовать в бета-версии. В дальнейшем используйте путь /admin/people.

Отклик

HTTP/1.1 204 No Content

Настройка свойств карточки профиля с помощью PowerShell

Вы можете использовать пакет SDK Для Microsoft Graph PowerShell для настройки свойств карточки профиля в организации.

Предварительные условия

• Модуль PowerShell — установка модуля версии 1.24.0 или более поздней.
• .NET Framework — установите .NET Framework 4.7.2 или более поздней версии.

Подтверждение текущих параметров

Чтобы получить конфигурацию свойств карточки профиля для организации, используйте следующую команду.

   Get-MgAdminPeopleProfileCardProperty

Чтобы получить определенную конфигурацию свойств карточки профиля в организации, используйте следующую команду.

   Get-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Примечание.

Для команд get требуется PeopleSettings.Read.All разрешение. Чтобы создать сеанс Microsoft Graph с определенной обязательной областью, используйте следующую команду и предоставьте запрошенные разрешения.

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

Добавление свойств карточки профиля в организации

С помощью модуля PowerShell Microsoft Graph можно сделать доступными в вашей организации атрибуты идентификатора Microsoft Entra и 15 настраиваемых атрибутов расширения идентификатора Microsoft Entra.

Примечание.

Для новой команды требуется PeopleSettings.ReadWrite.All разрешение. Чтобы создать сеанс Microsoft Graph с определенной обязательной областью, используйте следующую команду и предоставьте запрошенные разрешения.

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

Используйте следующую команду.

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

New-MgAdminPeopleProfileCardProperty -BodyParameter $params

Обновление свойств карточки профиля в организации

Вы можете использовать модуль Microsoft Graph PowerShell для обновления свойств карточки профиля, доступных в вашей организации.

Примечание.

Для выполнения команды обновления требуется PeopleSettings.ReadWrite.All разрешение. Чтобы создать сеанс Microsoft Graph с определенной обязательной областью, используйте следующую команду и предоставьте запрошенные разрешения.

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

Используйте следующую команду, в которой замените $profileCardPropertyId идентификатором обновляемого свойства.

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

Update-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId -BodyParameter $params

Удаление свойств карточки профиля в организации

Вы можете использовать модуль Microsoft Graph PowerShell для удаления свойств карточки профиля из организации.

Примечание.

Для выполнения команды remove требуется PeopleSettings.ReadWrite.All разрешение. Чтобы создать сеанс Microsoft Graph с определенной обязательной областью, используйте следующую команду и предоставьте запрошенные разрешения.

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

Используйте следующую команду, где замените $profileCardPropertyId идентификатором удаляемого свойства.

 Remove-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

Связанные материалы

• Тип ресурса onPremisesExtensionAttributes
• Тип ресурса user
• Песочница Graph
• Получение ресурса profileCardProperty
• Запросы субъектов данных Azure в рамках GDPR и CCPA
• На каких языках доступна карточка профиля?