更新 educationSynchronizationProfile
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
更新租户中现有学校数据 同步配置文件 的属性。
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | EduAdministration.ReadWrite | 不可用。 |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | 不支持。 | 不支持。 |
HTTP 请求
PUT /education/synchronizationProfiles
请求标头
名称 | 类型 | 说明 |
---|---|---|
Authorization | string | 持有者 {token}。 必填。 |
Content-Type | string | application/json. 必需。 |
请求正文
在请求正文中,提供 synchronizationProfile 对象的 JSON 表示形式。
响应
如果成功,此方法在 202, Accepted
响应正文中返回响应代码和 synchronizationProfile 对象。
示例
请求
以下示例显示了一个请求。
PUT https://graph.microsoft.com/beta/education/synchronizationProfiles
Content-type: application/json
{
"displayName": "Test Profile",
"dataProvider": {
"@odata.type": "microsoft.graph.educationcsvdataprovider",
"customizations": {
"student": {
"optionalPropertiesToSync": [
"State ID",
"Middle Name"
]
}
}
},
"identitySynchronizationConfiguration": {
"@odata.type": "microsoft.graph.educationidentitycreationconfiguration",
"userDomains": [
{
"appliesTo": "student",
"name": "testschool.edu"
},
{
"appliesTo": "teacher",
"name": "testschool.edu"
}
]
},
"licensesToAssign": [
{
"appliesTo": "teacher",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
},
{
"appliesTo": "student",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
}
]
}
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 202 Accepted
Content-type: application/json
{
"displayName": "Test Profile",
"state": "provisioning",
"id": "86904b1e-c7d0-4ead-b13a-98f11fc400ee",
"dataProvider": {
"@odata.type": "#microsoft.graph.educationCsvDataProvider",
"customizations": {
"school": {
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"section": {
"optionalPropertiesToSync": [
"Term Name",
"Course Number",
"Periods"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"student": {
"optionalPropertiesToSync": [
"State ID",
"Middle Name"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"teacher": {
"optionalPropertiesToSync": [
"State ID",
"Teacher Number",
"Status",
"Middle Name",
"Secondary Email",
"Title",
"Qualification"
],
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"studentEnrollment": {
"synchronizationStartDate": "0001-01-01T00:00:00Z",
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
},
"teacherRoster": {
"isSyncDeferred": false,
"allowDisplayNameUpdate": false
}
}
},
"identitySynchronizationConfiguration": {
"@odata.type": "microsoft.graph.educationIdentityCreationConfiguration",
"userDomains": [
{
"appliesTo": "student",
"name": "testschool.edu"
},
{
"appliesTo": "teacher",
"name": "testschool.edu"
}
]
},
"licensesToAssign": [
{
"@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment",
"appliesTo": "teacher",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
},
{
"@odata.type": "microsoft.graph.educationSynchronizationLicenseAssignment",
"appliesTo": "student",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
}
]
}
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈