同期の取得Schema

  • [アーティクル]

名前空間: microsoft.graph

特定の同期ジョブまたはテンプレートのスキーマを取得します。

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

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

アクセス許可

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

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) Synchronization.Read.All Synchronization.ReadWrite.All、CustomSecAttributeProvisioning.Read.All、CustomSecAttributeProvisioning.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション CustomSecAttributeProvisioning.Read.All Application.ReadWrite.OwnedBy、CustomSecAttributeProvisioning.ReadWrite.All、Synchronization.Read.All、Synchronization.ReadWrite.All

アプリケーション プロビジョニングまたは HR ドリブン プロビジョニングを構成するには、呼び出し元のユーザーにも少なくとも アプリケーション管理者 または クラウド アプリケーション管理者ディレクトリ ロールを割り当てる必要があります。

Cloud Sync Microsoft Entra構成するには、呼び出し元のユーザーにも少なくともハイブリッド ID 管理者ディレクトリ ロールを割り当てる必要があります。

HTTP 要求

GET /servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
GET /servicePrincipals/{id}/synchronization/templates/{templateId}/schema
GET /applications/{id}/synchronization/templates/{templateId}/schema

要求ヘッダー

名前 型 説明
Authorization string ベアラー {token}。 必須です。

要求本文

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

応答

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

例

要求

次の例は要求を示しています。

GET https://graph.microsoft.com/v1.0/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
応答

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

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。 すべてのプロパティは、実際の呼び出しで返されます。

HTTP/1.1 200 OK

{
    "directories": [
        {
            "name": "Azure Active Directory",
            "objects": [
                {
                    "name": "User",
                    "attributes": [
                        {
                            "name": "userPrincipalName",
                            "type": "string"
                        }
                    ]
                }
            ]
        },
        {
            "name": "Salesforce",
            "objects": [{}]
        }
    ],
    "synchronizationRules":[
        {
            "name": "USER_TO_USER",
            "sourceDirectoryName": "Azure Active Directory",
            "targetDirectoryName": "Salesforce",
            "objectMappings": [
                {
                    "sourceObjectName": "User",
                    "targetObjectName": "User",
                    "attributeMappings": [
                        {
                            "source": {},
                            "targetAttributeName": "userName"
                        },
                        {}
                    ]
                },
                {}
            ]
        },
        {}
    ]
}