Добавление или удаление настраиваемых атрибутов в карточке профиля с помощью API карточки профиля (предварительная версия)
На карточке профиля в Microsoft 365 находится информация о пользователях, сохраненная и управляемая вашей организацией, например Должность или Местонахождение офиса.
Используйте ресурс profileCardProperty, чтобы отобразить дополнительные свойства из Azure AD на карточках профиля для организации:
- Обеспечение видимости дополнительных атрибутов
- Добавление настраиваемых атрибутов
Дополнительные свойства отображаются в разделе Контакт карточки профиля в Microsoft 365.
Вы также можете удалить настраиваемые атрибуты из карточек профилей организации.
Примечание.
Операции в ресурсе profileCardProperty, использующем делегированные разрешения, требуют, чтобы у вошедшего пользователя была роль администратора клиента или глобального администратора.
Обеспечение видимости дополнительных атрибутов
Вы можете сделать видимыми в карточках профилей пользователей следующие атрибуты из Azure Active Directory (Azure AD). В этих атрибутах регистр не учитывается:
UserPrincipalName
Fax
StreetAddress
PostalCode
StateOrProvince
Alias
В таблице ниже показано соответствие атрибутов Azure AD свойствам объекта user Microsoft Graph.
Атрибут Azure AD | Свойство объекта 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/beta/organization/{tenantid}/settings/profileCardProperties
Content-Type: application/json
{
"directoryPropertyName": "Alias"
}
При успешном выполнении возвращается код отклика 201 OK
и объект profileCardProperty в тексте отклика. Значение атрибута Alias
отображается в карточке профиля пользователя.
HTTP/1.1 201 OK
Content-type: application/json
{
"directoryPropertyName": "Alias",
"annotations": []
}
Добавление настраиваемого атрибута
Вы можете добавлять в карточки профилей пользователей любой из 15 настраиваемых атрибутов расширений Azure AD путем настройки параметров организации и добавления соответствующего значения в качестве profileCardProperty в Microsoft Graph. Вы можете добавить один ресурс profileCardProperty за один раз.
Отображение внесенных изменений в карточках профилей занимают до 24 часов.
Настраиваемые свойства не поддерживают поиск, и их невозможно использовать для поиска людей в различных приложениях и службах Майкрософт.
В таблице ниже показано, как имена настраиваемых атрибутов расширений Azure AD соответствуют поддерживаемым значениям свойства directoryPropertyName ресурса profileCardProperty. В именах настраиваемых атрибутов расширений Azure AD регистр не учитывается:
Настраиваемый атрибут расширения Azure AD | Значение, указываемое в качестве directoryPropertyName |
---|---|
extensionAttribute1 | customAttribute1 |
extensionAttribute2 | customAttribute2 |
extensionAttribute3 | customAttribute3 |
extensionAttribute4 | customAttribute4 |
extensionAttribute5 | customAttribute5 |
extensionAttribute6 | customAttribute6 |
extensionAttribute7 | customAttribute7 |
extensionAttribute8 | customAttribute8 |
extensionAttribute9 | customAttribute9 |
extensionAttribute10 | customAttribute10 |
extensionAttribute11 | customAttribute11 |
extensionAttribute12 | customAttribute12 |
extensionAttribute13 | customAttribute13 |
extensionAttribute14 | customAttribute14 |
extensionAttribute15 | customAttribute15 |
Пример
В следующем примере в карточку профиля добавляется первый настраиваемый атрибут расширения Azure AD, используемый для отображения имени Cost center. Для пользователей, выбравших в языковых настройках немецкий язык, отображаемым именем будет Kostenstelle.
Запрос
POST https://graph.microsoft.com/beta/organization/{tenantid}/settings/profileCardProperties
Content-Type: application/json
{
"directoryPropertyName": "customAttribute1",
"annotations": [
{
"displayName": "Cost center",
"localizations": [
{
"languageTag": "de",
"displayName": "Kostenstelle"
}
]
}
]
}
Если язык не поддерживается, имя свойства отображается с использованием значения по умолчанию.
При успешном выполнении возвращается код отклика 201 OK
и объект profileCardProperty в тексте отклика. В этом примере вы можете предположить, что в карточке профиля отображается Kostenstelle для всех пользователей, выбравших в языковых настройках немецкий язык. Для всех остальных пользователей в карточке профиля отображается Cost center.
Отклик
HTTP/1.1 201 OK
Content-type: application/json
{
"directoryPropertyName": "customAttribute1",
"annotations": [
{
"displayName": "Cost center",
"localizations": [
{
"languageTag": "de",
"displayName": "Kostenstelle"
}
]
}
]
}
Удаление настраиваемого атрибута.
Следуя аналогичному сопоставлению между настраиваемыми атрибутами расширения Azure AD и настраиваемыми атрибутами карточки профиля (например, customAttribute1
), как описано в предыдущем разделе Добавление настраиваемого атрибута, вы можете удалить настраиваемый атрибут с помощью операции удаления, как показано в примере ниже:
Пример
В следующем примере настраиваемый атрибут customAttribute5
удаляется из параметров организации. После успешного удаления возвращается HTTP 204
.
Запрос
DELETE https://graph.microsoft.com/beta/organization/{organizationId}/settings/profileCardProperties/customAttribute5
Отклик
HTTP/1.1 204 No Content