educationUser-Ressourcentyp

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Ein Benutzer im System. Dies ist eine bildungsspezifische Variante der [Standardbenutzerressource] mit derselbenid, die Microsoft Graph vom nicht educationspezifischen /users Endpunkt zurückgibt.

Dieses Objekt stellt eine gezielte Teilmenge von Eigenschaften aus dem [Kernbenutzerobjekt] bereit und fügt eine Reihe von bildungsspezifischen Eigenschaften hinzu, z primaryRole. B. , studentund teacher.

Methoden

Methode Rückgabetyp Beschreibung
educationUser 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 Keine Löschen eines educationUser-Objekts.
Delta educationUser-Sammlung Rufen Sie 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 Boolesch 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 Zeichenfolge 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 bestimmt aus externalSourceDetail). Mögliche Werte: sis, lms oder manual.
externalSourceDetail Zeichenfolge Der Name der externen Quelle, aus der diese Ressourcen generiert wurden.
givenName String Der Vorname des Benutzers. Unterstützt $Filter.
mail Zeichenfolge Die SMTP-Adresse des Benutzers, z. B. „jeff@contoso.onmicrosoft.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.
onPremisesInfo educationOnPremisesInfo Zusätzliche Informationen, die verwendet werden, um den AAD Benutzer dem Active Directory-Gegenstück zuzuordnen.
passwordPolicies String Gibt die Kennwortrichtlinien für den Benutzer an. Weitere Details 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 Details 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-Auflistung] Verwandte Datensätze im Zusammenhang mit dem Benutzer. Mögliche Beziehungen sind parent, relative, aide, doctor, guardian, child, other``unknownFutureValue
residenceAddress physicalAddress Die Wohnadresse des Benutzers Hinweis: type und postOfficeBox werden für educationUser Ressourcen nicht unterstützt.
student educationStudent Ist die primäre Rolle Kursteilnehmer, enthält dieser Block spezifische Daten für Kursteilnehmer.
surname Zeichenfolge Der Nachname des Benutzers. Unterstützt $Filter.
teacher educationTeacher Wenn die primäre Rolle "Lehrer" ist, enthält dieser Block lehrerspezifische Daten.
usageLocation Zeichenfolge Ein aus zwei Buchstaben bestehender Ländercode (ISO 3166 Alpha-2). Erforderlich für Benutzer, denen Lizenzen zugewiesen werden. Lässt keine Nullwerte zu. Unterstützt $Filter.
userPrincipalName Zeichenfolge Der Benutzerprinzipalname (USER Principal Name, UPN) für den Benutzer. Unterstützt $filter und $orderby. Weitere Details finden Sie in der [Standardbenutzerressource] .
userType Zeichenfolge 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``accountEnabled, , givenName``displayName, , surname, userPrincipalName, student/externalId``userType``onPremisesInfo``teacher/externalId, . Wenn Ihre Anwendung zusätzliche Eigenschaften erfordert, müssen Sie Anwendungsberechtigungsbereiche verwenden.

Beziehungen

Beziehung Typ Beschreibung
assignments educationAssignment Liste der Aufgaben für den Benutzer. Lässt NULL-Werte zu.
classes educationClass-Sammlung Klassen, zu denen der Benutzer gehört. Lässt Nullwerte zu.
schools educationSchool-Sammlung Schulen, zu denen der Benutzer gehört. Lässt Nullwerte zu.
taughtClasses educationClass-Sammlung Kurse, für die der Benutzer Lehrer ist.
Rubriken educationRubric-Sammlung Wenn diese Einstellung festgelegt ist, wird die benotende Rubrik, die der Aufgabe zugeordnet ist, festgelegt.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "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"
}