objectConnection の取得

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

synchronizationJob 内の既知のオブジェクトの objectConnection キャッシュされたリンケージ レコードを取得します。

パブリック プレビュー中は、既知の objectId を指定する必要があります。 コレクションの一覧表示はサポートされていません。 objectConnections コレクションへの GET 要求は 400 Bad Request を返します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) SynchronizationMetadata.Read.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション SynchronizationMetadata.Read.OwnedBy SynchronizationMetadata.Read.All

SynchronizationMetadata.ReadWrite.All アクセス許可は、委任された職場または学校アカウントとアプリケーションに対してもこの操作をサポートします。 SynchronizationMetadata.ReadWrite.OwnedBy アプリケーションのアクセス許可もこの操作をサポートします。

SynchronizationMetadata.Read.OwnedBy および SynchronizationMetadata.ReadWrite.OwnedBy アプリケーションのアクセス許可は、呼び出し元のアプリケーションが所有するサービス プリンシパルに関連付けられている同期ジョブへのアクセスを制限します。

HTTP 要求

GET /servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/objectConnections/{objectId}

{objectId} を、この同期ジョブのオブジェクトの正確なソースまたはターゲット識別子に置き換えます。 たとえば、接続の Microsoft Entra 側には Microsoft Entra オブジェクト ID を使用し、Workday ソースには Workday ワーカーの WID を使用します。 サービスは、最初にソース識別子を検索し、次にターゲット識別子を検索します。 識別子の元の形式を保持します。

オプションのクエリ パラメーター

このメソッドでは、応答をカスタマイズするために $select OData クエリ パラメーターのみがサポートされます。 他の OData クエリ パラメーターはサポートされていません。 一般的な情報については、「OData クエリ パラメーター」を参照してください。

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは応答本文で 200 OK 応答コードと objectConnection オブジェクトを返します。

エラー

HTTP の状態 条件
401 Unauthorized 呼び出し元が認証されていないか、委任されたスコープがないか、または委任された承認チェックに失敗しました。
403 Forbidden 必要なアプリケーションのアクセス許可が見つからないか、呼び出し元が要求された同期ジョブにアクセスできません。
404 Not Found 同期ジョブまたはオブジェクトの接続が存在しません。
429 Too Many Requests 要求は調整されます。

例

要求

次の例では、ソース ユーザーの Microsoft Entra オブジェクト ID を {objectId} として使用します。

GET https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipal-id}/synchronization/jobs/{synchronizationJob-id}/objectConnections/9d47c4a5-0d5a-4c0e-91b6-6f6c9c6e4c77

応答

次の例は応答を示しています。

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

{
  "objectId": "9d47c4a5-0d5a-4c0e-91b6-6f6c9c6e4c77",
  "sourceAnchor": "9d47c4a5-0d5a-4c0e-91b6-6f6c9c6e4c77",
  "targetAnchor": "EXTERNAL_userA",
  "displayName": "User A",
  "objectTypeName": "User"
}