次の方法で共有


Microsoft Graph APIを使用してorganizationのプロファイル ソース設定を管理する

プロファイル ソースの構成により、エンド ユーザー エクスペリエンスが向上し、プロファイル データのソースが明確でわかりやすいものになります。

この管理者ガイドでは、Microsoft Graph API を使用してorganizationでプロファイル ソース設定を構成する方法について説明します。 organizationでプロファイル ソースを追加、更新、削除するために必要な手順について詳しく説明し、プロファイル データがさまざまな Microsoft 365 エクスペリエンスで正確に属性付けされ、表示されるようにします。

重要

既定では、Microsoft Entra IDはorganization内のプロファイル データのソースです。 organization管理者は、読み取り可能で一意のプロファイル ソース識別子である sourceId プロパティを設定します。 sourceId プロパティは更新可能ではなく、プロファイル ソースのクエリを実行するときに代替キーとして使用できます。 プロファイル ソースは、 id という名前のシステム生成キーを使用して識別できます。

管理者は、 ローカリゼーション プロパティを使用して、複数のロケールのプロファイル ソースの表示名をカスタマイズできます。

Microsoft Graph APIを使用してプロファイル ソース設定を構成する

profileSource API を使用して、organizationでプロファイル ソースを構成できます。

現在の設定を確認する

List 操作を使用して、organization内のプロファイル ソースの現在の設定を返します。

次の例では、organization内のプロファイル ソースのコレクションを取得します。

GET https://graph.microsoft.com/beta/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"
        }
      ]
    }
  ]
}

プロファイル ソースを追加する

[作成] 操作を使用して、organizationにプロファイル ソースを追加します。

要求

POST https://graph.microsoft.com/beta/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 操作を使用して、organization内のプロファイル ソースを変更します。

要求

PATCH https://graph.microsoft.com/beta/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"
    }
  ]
}

プロファイル ソースを削除する

削除操作を使用して、organization内のプロファイル ソースを削除します。

要求

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

成功した場合、このメソッドは 204 No Content 応答コードを返します。

応答

HTTP/1.1 204 No Content

Microsoft Graph PowerShell SDK を使用してプロファイル ソース設定を構成する

Microsoft Graph PowerShell SDK を使用して、organizationでプロファイル ソース設定を構成できます。

前提条件

注:

プロファイル ソース設定の PowerShell コマンドは、ベータ版でのみ使用できます。 次のコマンドを実行する前に、ベータ エクスペリエンスに切り替えます。

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

現在の設定を確認する

organizationのプロファイル ソース設定の構成を取得するには、次のコマンドを使用します。

Get-MgBetaAdminPeopleProfileSource

organizationでプロファイル ソース設定の構成を取得するには、次のコマンドを使用します。

Get-MgBetaAdminPeopleProfileSource -ProfileSourceId $id

注:

get コマンドには、 PeopleSettings.Read.All アクセス許可が必要です。 特定の必要なスコープを持つ Microsoft Graph セッションを作成するには、次のコマンドを使用し、要求されたアクセス許可に同意します。

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

organizationにプロファイル ソース設定を追加する

Microsoft Graph PowerShell モジュールを使用して、organizationでプロファイル ソース設定を構成できます。 新しいコマンドには 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

organizationでプロファイル ソース設定を更新する

Microsoft Graph PowerShell モジュールを使用して、organizationのプロファイル ソース設定を更新できます。 update コマンドには 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

organizationでプロファイル ソース設定を削除する

Microsoft Graph PowerShell モジュールを使用して、organizationからプロファイル ソース設定を削除できます。 remove コマンドには PeopleSettings.ReadWrite.All アクセス許可が必要です。また、特定の必要なスコープを持つ Microsoft Graph セッションを作成するには、次のコマンドを使用して、要求されたアクセス許可に同意します。

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

organizationのプロファイル ソースの優先順位設定を管理する