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

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

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

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

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

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

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

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

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

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

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

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

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

Настройка свойств карта профиля с помощью 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 ID соответствуют поддерживаемым значениям свойства directoryPropertyName ресурса profileCardProperty. Эти Microsoft Entra ID имена настраиваемых атрибутов расширений не учитывает регистр:

Пример

В следующем примере первый атрибут Microsoft Entra ID пользовательского расширения добавляется в карта профиля с помощью отображаемого имени Cost Center. Для пользователей, которые задают для своих языковых параметров значение немецкий, отображаемое имя — 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

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

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

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

   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 можно использовать для обновления профиля карта свойств, доступных в вашей организации.

   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, чтобы удалить свойства профиля карта из организации.

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

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

 Remove-MgAdminPeopleProfileCardProperty -ProfileCardPropertyId $profileCardPropertyId

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

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