Mettre à jour educationUser

Espace de noms: microsoft.graph

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

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

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	❌	❌	❌

Autorisations

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

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
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 l’autorisation.
Content-Type	application/json

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
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	String collection	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. Il s’agit généralement de la combinaison du prénom de l’utilisateur, de l’initiale de son deuxième prénom et de son nom. Cette propriété est requise lorsqu’un utilisateur est créé et ne peut pas être effacée pendant les mises à jour. Prend en charge $filter et $orderby.
externalSource	educationExternalSource	Endroit à partir duquel cet utilisateur a été créé. Les valeurs possibles sont les suivantes : sis, 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.
mail	String	Adresse SMTP de l’utilisateur ; par exemple, «jeff@contoso.com ». En lecture seule. Prend en charge $filter.
mailingAddress	physicalAddress	Adresse de messagerie de l’utilisateur.
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.
middleName	String	Deuxième prénom de l’utilisateur.
mobilePhone	String	Numéro de téléphone portable principal de l’utilisateur.
onPremisesInfo	educationOnPremisesInfo	Informations supplémentaires utilisées pour associer l’utilisateur AAD à son équivalent Active Directory.
passwordPolicies	String	Spécifie les stratégies de mot de passe de l’utilisateur. Cette valeur est une énumération avec une seule valeur possible, « DisableStrongPassword », qui permet de spécifier des mots de passe plus faibles que la stratégie par défaut. Vous pouvez également spécifier la valeur « DisablePasswordExpiration ». Les deux valeurs peuvent être spécifiées ensemble, par exemple : « DisablePasswordExpiration, DisableStrongPassword ».
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éé. Le mot de passe du profil doit respecter les exigences minimales spécifiées par la propriété passwordPolicies. Par défaut, un mot de passe fort est requis.
preferredLanguage	String	Langue par défaut de l’utilisateur. Doit respecter le Code ISO 639-1, par exemple « fr-FR ».
primaryRole	educationUserRole	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 les suivantes : student, teacher, none, unknownFutureValue.
provisionedPlans	collection provisionedPlan	Plans de charge configurés pour l’utilisateur. En lecture seule. Ne pouvant accepter la valeur null.
residenceAddress	physicalAddress	Adresse à laquelle habite l’utilisateur.
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 (norme ISO 3166). Obligatoire pour les utilisateurs qui recevront des licences en raison d’une obligation légale qui exige la vérification de la disponibilité des services dans les pays ou régions. Voici quelques exemples : « US », « JP » et « GB ». Ne peut accepter une valeur null. Prend en charge $filter.
userPrincipalName	String	Nom d’utilisateur principal (UPN) de l’utilisateur.
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.

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.

HTTP

PATCH https://graph.microsoft.com/v1.0/education/users/{user-id}
Content-type: application/json

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new EducationUser
{
	DisplayName = "Rogelio Cazares",
	GivenName = "Rogelio",
	MiddleName = "Fernando",
	Surname = "Cazares",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Users["{educationUser-id}"].PatchAsync(requestBody);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

mgc education users patch --education-user-id {educationUser-id} --body '{\
  "displayName": "Rogelio Cazares",\
  "givenName": "Rogelio",\
  "middleName": "Fernando",\
  "surname": "Cazares",\
}\
'

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewEducationUser()
displayName := "Rogelio Cazares"
requestBody.SetDisplayName(&displayName) 
givenName := "Rogelio"
requestBody.SetGivenName(&givenName) 
middleName := "Fernando"
requestBody.SetMiddleName(&middleName) 
surname := "Cazares"
requestBody.SetSurname(&surname) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
users, err := graphClient.Education().Users().ByEducationUserId("educationUser-id").Patch(context.Background(), requestBody, nil)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EducationUser educationUser = new EducationUser();
educationUser.setDisplayName("Rogelio Cazares");
educationUser.setGivenName("Rogelio");
educationUser.setMiddleName("Fernando");
educationUser.setSurname("Cazares");
EducationUser result = graphClient.education().users().byEducationUserId("{educationUser-id}").patch(educationUser);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const educationUser = {
  displayName: 'Rogelio Cazares',
  givenName: 'Rogelio',
  middleName: 'Fernando',
  surname: 'Cazares',
};

await client.api('/education/users/{user-id}')
	.update(educationUser);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\EducationUser;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EducationUser();
$requestBody->setDisplayName('Rogelio Cazares');
$requestBody->setGivenName('Rogelio');
$requestBody->setMiddleName('Fernando');
$requestBody->setSurname('Cazares');

$result = $graphServiceClient->education()->users()->byEducationUserId('educationUser-id')->patch($requestBody)->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PowerShell

Import-Module Microsoft.Graph.Education

$params = @{
	displayName = "Rogelio Cazares"
	givenName = "Rogelio"
	middleName = "Fernando"
	surname = "Cazares"
}

Update-MgEducationUser -EducationUserId $educationUserId -BodyParameter $params

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.education_user import EducationUser
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EducationUser(
	display_name = "Rogelio Cazares",
	given_name = "Rogelio",
	middle_name = "Fernando",
	surname = "Cazares",
)

result = await graph_client.education.users.by_education_user_id('educationUser-id').patch(request_body)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

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