同期の更新Schema

[アーティクル]
06/22/2024

名前空間: microsoft.graph

特定のジョブまたはテンプレートの同期スキーマを更新します。このメソッドは、現在のスキーマを要求で指定されたものに完全に置き換えます。テンプレートのスキーマを更新するには、アプリケーションオブジェクトでを呼び出します。アプリケーションの所有者である必要があります。

アクセス許可

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

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

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

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

HTTP 要求

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

要求ヘッダー

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

要求本文

要求本文で、既存のスキーマをに置き換える synchronizationSchema オブジェクトを指定します。

応答

成功した場合は、 204 No Content 応答コードを返します。応答本文では何も返されません。

例

要求

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

手記： ここで示す要求オブジェクトは、読みやすくするために短縮されています。実際の呼び出しですべてのプロパティを指定します。

HTTP
JavaScript

PUT https://graph.microsoft.com/v1.0/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema
Content-type: application/json

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


const options = {
	authProvider,
};

const client = Client.init(options);

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

await client.api('/servicePrincipals/{id}/synchronization/jobs/{jobId}/schema')
	.put(synchronizationSchema);

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

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

HTTP/1.1 204 No Content

次の方法で共有