Type de ressource educationUser
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente un utilisateur dans le système. Cette ressource est une variante spécifique à l’éducation de la ressource utilisateur standard, avec la même id que celle retournée par Microsoft Graph à partir du point de terminaison non spécifique /users à l’éducation.
Cet objet fournit un sous-ensemble ciblé de propriétés de l’objet utilisateur principal et ajoute un ensemble de propriétés spécifiques à l’éducation telles que primaryRole, studentet teacher.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Obtenir un utilisateur | educationUser | Lisez les propriétés et les relations d’un objet educationUser. |
| Répertorier des cours | Ensemble d’objets educationClass | Obtenez la collection d’objets educationClass pour laquelle l’utilisateur est membre. |
| Répertorier les établissements scolaires | Ensemble d’objets educationSchool | Obtenez la collection d’objets educationSchool pour laquelle l’utilisateur est membre. |
| Obtenir un utilisateur | user | Obtenez le répertoire simple user qui correspond à l’objet educationUser. |
| Mettre à jour | educationUser | Mettez à jour un objet educationUser. |
| Supprimer un utilisateur | Aucun | Supprimez un objet educationUser. |
| Obtenir delta | Collection d’objets educationUser | Obtenez les modifications incrémentielles pour educationUsers. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| id | String | Identificateur unique de l’utilisateur. Hérité de directoryObject. Clé. Ne peut pas avoir la valeur Null. En lecture seule. |
| accountEnabled | Boolean | Valeur true si le compte est activé ; sinon, valeur false. Cette propriété est requise lorsqu’un utilisateur est créé. Prend en charge $filter. |
| assignedLicenses | collection assignedLicense | Licences attribuées à l’utilisateur. Ne pouvant accepter la valeur null. |
| assignedPlans | collection assignedPlan | Plans de charge affectés à l’utilisateur. En lecture seule. Ne pouvant accepter la valeur null. |
| businessPhones | Collection de chaînes | Numéros de téléphone de l’utilisateur. Remarque : bien qu’il s’agisse d’une collection de chaînes, seul un numéro peut être défini pour cette propriété. |
| createdBy | identitySet | Entité qui a créé l’utilisateur. |
| department | String | Nom du service où travaille l’utilisateur. Prend en charge $filter. |
| displayName | String | Nom affiché dans le carnet d’adresses de l’utilisateur. Prend en charge $filter et $orderby. |
| externalSource | Chaîne | Type de source externe à partir de laquelle cette ressource a été générée (déterminé automatiquement à partir de externalSourceDetail). Les valeurs possibles sont les suivantes : sis, lms ou manual. |
| externalSourceDetail | Chaîne | Nom de la source externe à partir de laquelle cette ressource a été générée. |
| givenName | String | Prénom de l’utilisateur. Prend en charge $filter. |
| String | Adresse SMTP de l’utilisateur ; par exemple, «jeff@contoso.com ». En lecture seule. Prend en charge $filter. | |
| mailNickname | String | Alias de messagerie de l’utilisateur. Cette propriété doit être spécifiée lors de la création d’un utilisateur. Prend en charge $filter. |
| mailingAddress | physicalAddress | Adresse de messagerie de l’utilisateur. Remarque : type et postOfficeBox ne sont pas pris en charge pour les educationUser ressources. |
| middleName | String | Deuxième prénom de l’utilisateur. |
| mobilePhone | String | Numéro de téléphone portable principal de l’utilisateur. |
| officeLocation | Chaîne | Emplacement du bureau de l’utilisateur. |
| onPremisesInfo | educationOnPremisesInfo | Informations supplémentaires utilisées pour associer l’utilisateur Microsoft Entra à son équivalent Active Directory. |
| passwordPolicies | String | Spécifie les stratégies de mot de passe de l’utilisateur. Pour plus d’informations, consultez la ressource utilisateur standard. |
| passwordProfile | passwordProfile | Spécifie le profil du mot de passe de l’utilisateur. Le profil contient le mot de passe de l’utilisateur. Cette propriété est requise lorsqu’un utilisateur est créé. Pour plus d’informations, consultez la ressource utilisateur standard. |
| preferredLanguage | String | Langue par défaut de l’utilisateur. Doit respecter le Code ISO 639-1, par exemple « fr-FR ». |
| primaryRole | string | Rôle par défaut pour un utilisateur. Le rôle de l’utilisateur peut être différent dans une classe individuelle. Les valeurs possibles sont student, teacher et faculty. Prend en charge $filter. |
| provisionedPlans | collection provisionedPlan | Plans de charge configurés pour l’utilisateur. En lecture seule. Ne pouvant accepter la valeur null. |
| relatedContacts | collection relatedContact | Enregistrements associés liés à l’utilisateur. Les relations possibles sont parent, relative, aide, doctor, guardian, child, other, unknownFutureValue |
| residenceAddress | physicalAddress | Adresse à laquelle habite l’utilisateur. Remarque : type et postOfficeBox ne sont pas pris en charge pour les educationUser ressources. |
| student | educationStudent | Si le rôle principal est student, ce bloc contient des données spécifiques à l’étudiant. |
| surname | String | Nom de l’utilisateur (nom de famille). Prend en charge $filter. |
| teacher | educationTeacher | Si le rôle principal est enseignant, ce bloc contient des données spécifiques à l’enseignant. |
| usageLocation | String | Code pays à deux lettres (ISO 3166 Alpha-2). Obligatoire pour les utilisateurs auxquels des licences sont attribuées. Ne peut accepter une valeur null. Prend en charge $filter. |
| userPrincipalName | String | Nom d’utilisateur principal (UPN) de l’utilisateur. Prend en charge $filter et $orderby. Pour plus d’informations, consultez la ressource utilisateur standard. |
| userType | String | Valeur de chaîne qui peut être utilisée pour classer les types d’utilisateur dans votre répertoire, tels que « Membre » et « Invité ». Prend en charge $filter. |
Importante
Lorsque vous utilisez des étendues d’autorisation déléguées, Graph retourne uniquement un ensemble limité de propriétés : id, accountEnabledprimaryRole, displayName, givenName, surname, onPremisesInfouserPrincipalNameuserTypestudent/externalIdteacher/externalId. Si votre application nécessite des propriétés supplémentaires, vous devez utiliser des étendues d’autorisation d’application.
Relations
| Relation | Type | Description |
|---|---|---|
| Affectations | educationAssignment | Liste des affectations pour l’utilisateur. Pouvant accepter la valeur Null. |
| classes | Ensemble d’objets educationClass | Cours auxquels appartient l’utilisateur. Peut avoir la valeur Null. |
| schools | Ensemble d’objets educationSchool | Établissements scolaires auxquels appartient l’utilisateur. Pouvant accepter la valeur Null. |
| taughtClasses | Ensemble d’objets educationClass | Classes pour lesquelles l’utilisateur est enseignant. |
| Rubriques | educationRubric collection | Lorsqu’elle est définie, la rubrique de notation attachée à l’affectation. |
Représentation JSON
La représentation JSON suivante montre le type de 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"
}