Mise à jour des propriétés d’un objet 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 .

Mettez à jour les propriétés d’un objet educationuser.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ❌ ❌ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) Non prise en charge. Non prise en charge.
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application EduRoster.ReadWrite.All Non disponible.

Requête HTTP

PATCH /education/me
PATCH /education/users/{id}

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété. Pour de meilleures performances, n’incluez pas de valeurs existantes qui n’ont pas été modifiées.

Propriété Type Description
displayName String Nom d’affichage de l’utilisateur
givenName String Prénom
middleName String Deuxième prénom de l’utilisateur
surname String Nom de l’utilisateur
mail String Adresse électronique
mobilePhone String Numéro mobile d’utilisateurs
externalSource string Endroit à partir duquel cet utilisateur a été créé. Les valeurs possibles sont : sis, manual, ou lms.
mailingAddress physicalAddress Adresse de messagerie de l’utilisateur. Remarque : type et postOfficeBox ne sont pas pris en charge pour educationUser les ressources.
residenceAddress physicalAddress Adresse à laquelle habite l’utilisateur. Remarque : type et postOfficeBox ne sont pas pris en charge pour educationUser les ressources.
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, enum_sentinel.
student educationStudent Si le rôle principal est étudiant, ce bloc contient des données spécifiques à l’étudiant.
teacher educationTeacher Si le rôle principal est enseignant, ce bloc contient des données spécifiques à l’enseignant.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet educationUser mis à jour dans le corps de la réponse.

Exemple

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/education/users/13020
Content-type: application/json

{
  "displayName": "Rogelio Cazares",
  "givenName": "Rogelio",
  "middleName": "Fernando",
  "surname": "Cazares",
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "13020",
  "displayName": "Rogelio Cazares",
  "givenName": "Rogelio",
  "middleName": "Fernando",
  "surname": "Cazares",
  "mail": "rogelioC@contoso.com",
  "mobilePhone": "+1 (253) 555-0101",
  "createdBy": {
        "user": {
          "displayName": "Susana Rocha",
          "id": "14012",
        }
  },
  "externalSource": "sis",
  "mailingAddress": {
        "city": "Los Angeles",
        "countryOrRegion": "United States",
        "postalCode": "98055",
        "state": "CA",
        "street": "12345 Main St."
      },
  "primaryRole": "string",
  "residenceAddress": {
        "city": "Los Angeles",
        "countryOrRegion": "United States",
        "postalCode": "98055",
        "state": "CA",
        "street": "12345 Main St."
      },
  "student": {
      "primaryRole": "student",
      "externalId": "13005",
      "birthDate": "2001-01-01T00:00:00Z"
    }
}