Erstellen eines educationSynchronizationProfile-Elements
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Erstellen Sie eine Anforderung für ein neues Schuldatensynchronisierungsprofil im Mandanten. Fragen Sie die status ab, um die status des Profils abzurufen.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Berechtigungen
Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp | Berechtigungen mit den geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | EduAdministration.ReadWrite | Nicht verfügbar. |
Delegiert (persönliches Microsoft-Konto) | Nicht unterstützt | Nicht unterstützt |
Anwendung | Nicht unterstützt | Nicht unterstützt |
HTTP-Anforderung
POST /education/synchronizationProfiles
Anforderungsheader
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {token}. Erforderlich. |
Content-Type | string | Application/json. Erforderlich. |
Anforderungstext
Geben Sie im Anforderungstext eine JSON-Darstellung des educationSynchronizationProfile-Objekts an.
Antwort
Bei erfolgreicher Ausführung gibt die Methode den 202 Accepted
Antwortcode und ein educationSynchronizationProfile-Objekt im Antworttext zurück.
Beispiel
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
POST 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"
]
}
]
}
Antwort
Das folgende Beispiel zeigt die Antwort.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.
HTTP/1.1 201 Created
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": [
{
"appliesTo": "teacher",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
},
{
"appliesTo": "student",
"skuIds": [
"6fd2c87f-b296-42f0-b197-1e91e994b900"
]
}
]
}
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für