Управление параметрами источника профиля для организации с помощью microsoft API Graph

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

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

Важно!

По умолчанию Microsoft Entra ID является источником данных профиля в организации. Администратор организации задает свойство sourceId , которое является удобочитаемым и уникальным исходным идентификатором профиля. Свойство sourceId не обновляется и может использоваться в качестве альтернативного ключа при запросе источника профиля. Источник профиля можно идентифицировать с помощью созданного системой ключа с именем id.

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

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

Api profileSource можно использовать для настройки источника профилей в организации.

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

Используйте операцию List для возврата текущих параметров для источников профилей в организации.

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

GET https://graph.microsoft.com/v1.0/admin/people/profileSources

В случае успешного выполнения ответ возвращает код отклика 200 OK и объект profileSource в теле отклика.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "id": "27f1af7b-b166-4f5b-b994-ae135a581547",
      "sourceId": "bamboohr1",
      "kind": "BambooHR",
      "displayName": "HR Platform",
      "webUrl": "https://bamboohr.contoso.com/login",
      "localizations": [
        {
          "displayName" : "HR-Platform",
          "webUrl" : "http://bamboohr.contoso.com/en-us/login",
          "languageTag" : "en-us"
        },
        {
          "displayName" : "HR-Plattform",
          "webUrl" : "http://bamboohr.contoso.com/de/login",
          "languageTag" : "de"
        }
      ]
    },
    {
      "id": "520c18f8-0284-4d79-9b14-8a2d74461370",
      "sourceId": "4ce763dd-9214-4eff-af7c-da491cc3782d",
      "kind": "MSEntra",
      "displayName": "Contoso Microsoft Entra",
      "webUrl": "https://login.microsoftonline.com",
      "localizations": [
        {
          "displayName" : "Contoso Microsoft Entra",
          "webUrl" : "https://login.microsoftonline.com",
          "languageTag" : "en-us"
        }
      ]
    }
  ]
}

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

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

Запрос

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

{
  "sourceId": "bamboohr1",
  "displayName": "HR Platform",
  "kind": "BambooHR",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект profileSource в тексте отклика.

Отклик

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

{
  "id" : "27f1af7b-b166-4f5b-b994-ae135a581547",
  "sourceId": "bamboohr1",
  "kind": "BambooHR",
  "displayName": "HR Platform",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

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

Используйте операцию Update для изменения источника профиля в организации.

Запрос

PATCH https://graph.microsoft.com/v1.0/admin/people/profileSources(sourceId='bamboohr1')
Content-Type: application/json

{
  "displayName": "BambooHR Updated",
  "localizations": [
    {
      "displayName" : "HR-Platform",
      "webUrl" : "http://bamboohr.contoso.com/en-us/login",
      "languageTag" : "en-us"
    },
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

В случае успешного выполнения этот метод возвращает код отклика 200 OK и объект profileSource в тексте отклика.

Отклик

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

{
  "id" : "27f1af7b-b166-4f5b-b994-ae135a581547",
  "sourceId": "bamboohr1",
  "kind": "BambooHR",
  "displayName": "BambooHR Updated",
  "webUrl": "https://bamboohr.contoso.com/login",
  "localizations": [
    {
      "displayName" : "HR-Platform",
      "webUrl" : "http://bamboohr.contoso.com/en-us/login",
      "languageTag" : "en-us"
    },
    {
      "displayName" : "HR-Plattform",
      "webUrl" : "http://bamboohr.contoso.com/de/login",
      "languageTag" : "de"
    }
  ]
}

Удаление источника профиля

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

Запрос

DELETE https://graph.microsoft.com/v1.0/admin/people/profileSources(sourceId='bamboohr1')

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

Отклик

HTTP/1.1 204 No Content

Настройка параметров источника профиля с помощью пакета SDK Для Microsoft Graph PowerShell

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

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

Примечание.

Команды PowerShell для параметров источника профиля доступны только в бета-версии. Перед выполнением следующих команд переключитесь на бета-версию.

Install-Module -Name Microsoft.Graph.Beta -MinimumVersion 2.3.0
Update-Module Microsoft.Graph.Beta

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

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

Get-MgBetaAdminPeopleProfileSource

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

Get-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

Примечание.

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

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

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

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

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"
$params = @{
	displayName = "HR-Platform"
	sourceId = "hrPlatform1"
	webUrl = "http://bamboohr.contoso.com/login"
	localizations = @(
		@{
			displayName = "HR-Plattform"
			webUrl = "http://bamboohr.contoso.com/de/login"
			languageTag = "de"
		}
	)
}

New-MgBetaAdminPeopleProfileSource -BodyParameter $params

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

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

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"
$params = @{
	displayName = "HR-Platform Updated"
	sourceId = "hrPlatform1"
	webUrl = "http://bamboohr.contoso.com/login"
	localizations = @(
    @{
      displayName = "HR-Platform"
      webUrl = "http://bamboohr.contoso.com/en-us/login"
      languageTag = "en-us"
    },
		@{
			displayName = "HR-Plattform"
			webUrl = "http://bamboohr.contoso.com/de/login"
			languageTag = "de"
		}
	)
}

Update-MgBetaAdminPeopleProfileSource -ProfileSourceId $id -BodyParameter $params

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

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

Connect-MgGraph -Scopes "PeopleSettings.ReadWrite.All","PeopleSettings.Read.All"
Remove-MgBetaAdminPeopleProfileSource -ProfileSourceId $id 

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