educationUser-Ressourcentyp
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.
Stellt einen Benutzer im System dar. Diese Ressource ist eine bildungsspezifische Variante der Standardbenutzerressource , die von id Microsoft Graph vom nicht bildungsspezifischen /users Endpunkt zurückgegeben wird.
Dieses Objekt stellt eine gezielte Teilmenge von Eigenschaften aus dem Kernbenutzerobjekt bereit und fügt eine Reihe von education-spezifischen Eigenschaften wie primaryRole, studentund teacherhinzu.
Methoden
| Methode | Rückgabetyp | Beschreibung |
|---|---|---|
| Benutzer abrufen | educationUser | Lesen von Eigenschaften und Beziehungen eines educationUser-Objekts. |
| Klassen auflisten | educationClass-Sammlung | Abrufen der educationClass-Objektsammlung, in der der Benutzer Mitglied ist. |
| Schulen auflisten | educationSchool-Sammlung | Abrufen der educationSchool-Objektsammlung, in der der Benutzer Mitglied ist. |
| Benutzer abrufen | user | Abrufen des einfachen Verzeichnis-Benutzers, der diesem educationUser entspricht. |
| Aktualisieren | educationUser | Aktualisieren eines educationUser-Objekts. |
| Delete user | Keine | Löschen eines educationUser-Objekts. |
| Delta abrufen | educationUser-Sammlung | Ruft inkrementelle Änderungen für educationUsers ab. |
Eigenschaften
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| id | String | Der eindeutige Bezeichner des Benutzers. Geerbt von directoryObject. Key. Lässt keine Nullwerte zu. Schreibgeschützt. |
| accountEnabled | Boolean | True, wenn das Konto aktiviert ist; andernfalls false. Diese Eigenschaft ist erforderlich, wenn ein Benutzer erstellt wird. Unterstützt $filter. |
| assignedLicenses | assignedLicense collection | Die Lizenzen, die dem Benutzer zugewiesen sind. Lässt keine NULL-Werte zu. |
| assignedPlans | assignedPlan collection | Die Pläne, die dem Benutzer zugewiesen sind. Schreibgeschützt. Lässt keine NULL-Werte zu. |
| businessPhones | String-Sammlung | Die Telefonnummern für den Benutzer. Hinweis: Obwohl dies eine String-Sammlung ist, kann nur eine Nummer für diese Eigenschaft festgelegt werden. |
| createdBy | identitySet | Entität, die den Benutzer erstellt hat. |
| department | String | Der Name der Abteilung, in der der Benutzer arbeitet. Unterstützt $filter. |
| displayName | String | Der Name des Benutzers, der im Adressbuch angezeigt wird. Unterstützt $filter und $orderby. |
| externalSource | String | Der Typ der externen Quelle, aus der diese Ressource generiert wurde (automatisch von externalSourceDetailbestimmt). Mögliche Werte: sis, lms oder manual. |
| externalSourceDetail | String | Der Name der externen Quelle, aus der diese Ressource generiert wurde. |
| givenName | String | Der Vorname des Benutzers. Unterstützt $filter. |
| String | Die SMTP-Adresse für den Benutzer; Beispiel: "jeff@contoso.com". Schreibgeschützt. Unterstützt $filter. | |
| mailNickname | String | Der E-Mail-Alias für den Benutzer. Diese Eigenschaft muss beim Erstellen eines Benutzers angegeben werden. Unterstützt $filter. |
| mailingAddress | physicalAddress | E-Mail-Adresse des Benutzers Hinweis: type und postOfficeBox werden für educationUser Ressourcen nicht unterstützt. |
| middleName | String | Der zweite Vorname des Benutzers |
| mobilePhone | String | Die Nummer des primären Mobiltelefons für den Benutzer. |
| officeLocation | String | Der Bürostandort für den Benutzer. |
| onPremisesInfo | educationOnPremisesInfo | Zusätzliche Informationen, die verwendet werden, um den Microsoft Entra-Benutzer seinem Active Directory-Gegenstück zuzuordnen. |
| passwordPolicies | String | Gibt die Kennwortrichtlinien für den Benutzer an. Weitere Informationen finden Sie in der Standardbenutzerressource . |
| passwordProfile | passwordProfile | Gibt das Kennwortprofil für den Benutzer an. Das Profil enthält das Kennwort des Benutzers. Diese Eigenschaft ist erforderlich, wenn ein Benutzer erstellt wird. Weitere Informationen finden Sie in der Standardbenutzerressource . |
| preferredLanguage | String | Die bevorzugte Sprache für den Benutzer. Muss im ISO 639-1-Code angegeben werden. Beispiel: „en-US“. |
| primaryRole | string | Standardrolle für einen Benutzer. Die Rolle des Benutzers kann in einer einzelnen Klasse unterschiedlich sein. Mögliche Werte sind: student, teacher und faculty. Unterstützt $filter. |
| provisionedPlans | ProvisionedPlan-Sammlung | Die Pläne, die für den Benutzer bereitgestellt wurden. Schreibgeschützt. Lässt keine NULL-Werte zu. |
| relatedContacts | relatedContact-Sammlung | Verwandte Datensätze, die sich auf den Benutzer beziehen. Mögliche Beziehungen sind parent, relative, aide, doctor, guardian, child, otherunknownFutureValue |
| residenceAddress | physicalAddress | Die Wohnadresse des Benutzers Hinweis: type und postOfficeBox werden für educationUser Ressourcen nicht unterstützt. |
| student | educationStudent | Wenn die primäre Rolle "Student" ist, enthält dieser Block schülerspezifische Daten. |
| surname | String | Der Nachname des Benutzers. Unterstützt $filter. |
| teacher | educationTeacher | Wenn die primäre Rolle lehrer ist, enthält dieser Block lehrerspezifische Daten. |
| usageLocation | String | Ein aus zwei Buchstaben bestehender Ländercode (ISO 3166 Alpha-2). Erforderlich für Benutzer, denen Lizenzen zugewiesen sind. Lässt keine NULL-Werte zu. Unterstützt $filter. |
| userPrincipalName | String | Der Benutzerprinzipalname (UPN) für den Benutzer. Unterstützt $filter und $orderby. Weitere Informationen finden Sie in der Standardbenutzerressource . |
| userType | String | Ein Zeichenfolgenwert kann zum Klassifizieren der Benutzertypen in Ihrem Verzeichnis verwendet werden, z. B. "Member" und "Guest". Unterstützt $filter. |
Wichtig
Bei Verwendung delegierter Berechtigungsbereiche gibt Graph nur einen begrenzten Satz von Eigenschaften zurück: id, primaryRole, , displayNameaccountEnabled, givenName, , userPrincipalNamesurname, userTypeonPremisesInfo, student/externalId, . teacher/externalId Wenn Ihre Anwendung zusätzliche Eigenschaften erfordert, müssen Sie Anwendungsberechtigungsbereiche verwenden.
Beziehungen
| Beziehung | Typ | Beschreibung |
|---|---|---|
| assignments | educationAssignment | Liste der Zuweisungen für den Benutzer. Nullwerte zulassend. |
| classes | educationClass-Sammlung | Klassen, zu denen der Benutzer gehört. Lässt Nullwerte zu. |
| schools | educationSchool-Sammlung | Schulen, zu denen der Benutzer gehört. Nullwerte zulassend. |
| taughtClasses | educationClass-Sammlung | Klassen, für die der Benutzer ein Lehrer ist. |
| Rubriken | educationRubric-Sammlung | Wenn diese Einstellung festgelegt ist, wird die der Aufgabe angefügte Rubrik für die Benotung verwendet. |
JSON-Darstellung
Die folgende JSON-Darstellung zeigt den Ressourcentyp.
{
"accountEnabled": true,
"assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
"assignedPlans": [{ "@odata.type": "microsoft.graph.assignedPlan" }],
"businessPhones": ["String"],
"createdBy": { "@odata.type": "microsoft.graph.identitySet" },
"department": "String",
"displayName": "String",
"externalSource": "string",
"givenName": "String",
"id": "String (identifier)",
"mail": "String",
"mailNickname": "String",
"mailingAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
"middleName": "String",
"mobilePhone": "String",
"officeLocation": "String",
"onPremisesInfo": {
"@odata.type": "microsoft.graph.educationOnPremisesInfo"
},
"passwordPolicies": "String",
"passwordProfile": { "@odata.type": "microsoft.graph.passwordProfile" },
"preferredLanguage": "String",
"primaryRole": "string",
"provisionedPlans": [{ "@odata.type": "microsoft.graph.provisionedPlan" }],
"residenceAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
"student": { "@odata.type": "microsoft.graph.educationStudent" },
"surname": "String",
"teacher": { "@odata.type": "microsoft.graph.educationTeacher" },
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String"
}