Добавление или удаление настраиваемых атрибутов в карта профиля с помощью API карта профиля
В карта профиля в Microsoft 365 отображаются сведения о пользователе в организации. Информация, отображаемая в профиле карта, хранится и обслуживается организацией, например должность илирасположение Office.
Организации могут использовать ресурс profileCardProperty для отображения дополнительных свойств из Microsoft Entra ID в профиле карта для пользователя в организации:
- Обеспечение видимости дополнительных атрибутов
- Добавление настраиваемых атрибутов
Дополнительные свойства отображаются в разделе Контакт профиля карта в Microsoft 365.
Вы также можете удалить настраиваемые атрибуты из карточек профиля организации.
Примечание
Свойства карта профиля соответствуют атрибутам в Microsoft Entra ID. Добавление атрибута в качестве profileCardProperty в коллекцию profileCardProperties для организации настраивает карточки профиля для отображения значения атрибута. Удаление profileCardProperty из коллекции не приводит к удалению атрибута из Microsoft Entra ID, а удаляет конфигурацию, чтобы карточки профилей больше не отображали значение атрибута.
Примечание
Настройки профиля карта свойств, описанные в этой статье, не применяются к приложениям Win32, таким как Outlook и классические клиенты Office. Сведения о настройке свойств профиля карта в приложениях Win32 для организации см. в статье Настройка карта профиля в приложениях Win32 с помощью разделов реестра.
API-интерфейсы свойств профиля карта доступны в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Примечание
Для операций с ресурсом profileCardProperty , использующих делегированные разрешения, требуется, чтобы у пользователя, выполнившего вход, была роль администратора клиента.
Вы можете сделать следующие атрибуты из Microsoft Entra ID видимыми на карточках профиля пользователей. Эти атрибуты не чувствительны к регистру:
UserPrincipalName
Fax
StreetAddress
PostalCode
StateOrProvince
Alias
В следующей таблице показано, как атрибуты Microsoft Entra ID соответствуют свойствам сущности пользователя Microsoft Graph.
атрибут Microsoft Entra ID | Свойство объекта user |
---|---|
UserPrincipalName | userPrincipalName |
Fax | faxNumber |
StreetAddress | streetAddress |
PostalCode | postalCode |
StateOrProvince | state |
Alias | mailNickname |
Вы можете добавить любой из этих атрибутов в профиль карта, настроив параметры администратора пользователей и добавив атрибут в качестве свойства directoryPropertyNameобъекта profileCardProperty в Microsoft Graph. При отображении этих атрибутов необходимо использовать имена свойств для en-us
. Вам не требуется добавлять локализованные значения. Эти свойства автоматически отображаются в языковых параметрах, указанных пользователем для Microsoft 365.
Заметка: Значения свойств сущности пользователя содержат сведения о пользователе, хранящиеся и управляемые организацией.
Важно!
При добавлении атрибута в карта профиля на отображение добавления требуется до 24 часов.
В следующем примере в карточке профиля отображается атрибут 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 настраиваемый атрибут расширения | Значение, указываемое в качестве 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 пользовательского расширения добавляется в карта профиля с помощью отображаемого имени 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
Вы можете использовать пакет 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 ID, так и 15 настраиваемых атрибутов расширения Microsoft Entra ID.
Примечание
Для новой команды требуется 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