Actualizar educationUser

Espacio de nombres: microsoft.graph

Actualice las propiedades de un objeto educationUser .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	❌	❌	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	No admitida.	No admitida.
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	EduRoster.ReadWrite.All	No disponible.

Solicitud HTTP

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

Encabezados de solicitud

Encabezado	Valor
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json

Cuerpo de solicitud

En el cuerpo de la solicitud, proporcione los valores de los campos relevantes que deben actualizarse. Las propiedades existentes que no se incluyen en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad. Para obtener el mejor rendimiento, no incluya valores existentes que no hayan cambiado.

Propiedad	Tipo	Descripción
accountEnabled	Boolean	true si la cuenta está habilitada; en caso contrario, false. Esta propiedad es necesaria cuando se crea un usuario. Es compatible con $filter.
assignedLicenses	Colección assignedLicense	Las licencias asignadas al usuario. No admite valores NULL.
assignedPlans	Colección assignedPlan	Los planes asignados al usuario. Solo lectura. No admite valores NULL.
businessPhones	Colección string	Números de teléfono del usuario. Nota: Aunque se trata de una colección de cadenas, solo se puede establecer un número para esta propiedad.
createdBy	identitySet	Entidad que ha creado el usuario.
department	Cadena	El nombre del departamento en el que trabaja el usuario. Es compatible con $filter.
displayName	Cadena	Nombre del usuario que aparece en la libreta de direcciones. Suele ser la combinación del nombre del usuario, la inicial del segundo nombre y el apellido. Esta propiedad es necesaria cuando se crea un usuario y no se puede borrar durante las actualizaciones. Es compatible con $filter y $orderby.
externalSource	educationExternalSource	Indica desde dónde se ha creado este usuario. Los valores posibles son sis y manual.
externalSourceDetail	Cadena	Nombre del origen externo desde el que se generó este recurso.
givenName	Cadena	El nombre (nombre de pila) del usuario. Es compatible con $filter.
mail	Cadena	Dirección SMTP para el usuario; por ejemplo, "jeff@contoso.com". Solo lectura. Es compatible con $filter.
mailingAddress	physicalAddress	Dirección de correo del usuario.
mailNickname	Cadena	El alias de correo del usuario. Esta propiedad debe especificarse al crear un usuario. Es compatible con $filter.
middleName	String	Segundo nombre del usuario.
mobilePhone	String	El número de teléfono móvil principal del usuario.
onPremisesInfo	educationOnPremisesInfo	Información adicional que se usa para asociar el usuario de AAD a su homólogo de Active Directory.
passwordPolicies	String	Especifica las directivas de contraseña del usuario. Este valor es una enumeración con un valor posible que es "DisableStrongPassword", el cual permite especificar contraseñas menos seguras que la directiva predeterminada. También se puede especificar "DisablePasswordExpiration". Pueden especificarse los dos juntos; (por ejemplo: "DisablePasswordExpiration, DisableStrongPassword").
passwordProfile	passwordProfile	Especifica el perfil de contraseña del usuario. El perfil contiene la contraseña del usuario. Esta propiedad es necesaria cuando se crea un usuario. La contraseña del perfil debe cumplir los requisitos mínimos especificados por la propiedad passwordPolicies. De manera predeterminada, se requiere una contraseña segura.
preferredLanguage	String	Idioma preferido del usuario. Debe seguir el código ISO 639-1 (por ejemplo, "en-US").
primaryRole	educationUserRole	Rol predeterminado de un usuario. Puede que el rol del usuario sea distinto en una clase individual. Los valores posibles son: student, teacher, none y unknownFutureValue.
provisionedPlans	colección provisionedPlan	Planes que han sido provisionados para el usuario. Solo lectura. No admite valores NULL.
residenceAddress	physicalAddress	Dirección donde reside el usuario.
student	educationStudent	Si el rol principal es estudiante, este bloque contiene datos específicos del alumno.
surname	Cadena	El apellido (o apellidos) del usuario. Es compatible con $filter.
teacher	educationTeacher	Si el rol principal es profesor, este bloque contiene datos específicos del profesor.
usageLocation	String	Código de país de dos letras (norma ISO 3166). Es necesario para los usuarios a quienes se van a asignar licencias debido a un requisito legal de comprobación de disponibilidad en los países o las regiones. Estos son algunos ejemplos: "US", "JP" y "GB". No admite valores NULL. Es compatible con $filter.
userPrincipalName	Cadena	El nombre principal del usuario (UPN) del usuario.
userType	Cadena	Un valor de cadena puede utilizarse para clasificar los tipos de usuario en el directorio. Por ejemplo: "Miembro" e "Invitado". Es compatible con $filter.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto educationUser actualizado en el cuerpo de la respuesta.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc education users patch --education-user-id {educationUser-id} --body '{\
  "displayName": "Rogelio Cazares",\
  "givenName": "Rogelio",\
  "middleName": "Fernando",\
  "surname": "Cazares",\
}\
'

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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

users, err := graphClient.Education().Users().ByEducationUserId("educationUser-id").Patch(context.Background(), requestBody, nil)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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);

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del 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();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Education

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

Update-MgEducationUser -EducationUserId $educationUserId -BodyParameter $params

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.education_user import EducationUser

graph_client = GraphServiceClient(credentials, scopes)

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)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta. Nota: el objeto de respuesta que se muestra aquí puede haberse acortado para mejorar la legibilidad.

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