更新 educationUser

命名空间：microsoft.graph

更新 educationUser 对象 的属性。

权限

要调用此 API，需要以下权限之一。要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型	权限（从最低特权到最高特权）
委派（工作或学校帐户）	不支持。
委派（个人 Microsoft 帐户）	不支持。
应用程序	EduRoster.ReadWrite.All

HTTP 请求

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

请求标头

标头	值
Authorization	Bearer {token}。必需。
Content-Type	application/json

请求正文

在请求正文中，提供应更新的相关字段的值。 请求正文中不包括的现有属性将保留其以前的值，或根据对其他属性值的更改重新计算。 为了获得最佳性能，请勿加入尚未更改的现有值。

属性	类型	说明
accountEnabled	布尔	如果帐户已启用，则为 true；否则，为 false。 创建用户时此属性是必需的。 支持 $filter。
assignedLicenses	assignedLicense collection	分配给该用户的许可证。不可为 null。
assignedPlans	assignedPlan collection	分配给该用户的计划。只读。不可为 null。
businessPhones	String collection	用户的电话号码。 注意： 虽然这是字符串集合，但是只能为该属性设置一个号码。
createdBy	identitySet	创建了用户的实体。
department	String	用户工作部门的名称。支持 $filter。
displayName	String	用户通讯簿中显示的名称。 这通常是用户名字、中间名首字母和姓氏的组合。 此属性在创建用户时是必需的，并且在更新过程中不能清除。 支持 $filter 和 $orderby。
externalSource	educationExternalSource	创建此用户的位置。 可取值为：sis、manual。
externalSourceDetail	String	生成此资源的外部源的名称。
givenName	String	用户的名。支持 $filter。
mail	String	用户的 SMTP 地址；例如，“jeff@contoso.onmicrosoft.com”。 只读。 支持 $filter。
mailingAddress	physicalAddress	用户的邮件地址。
mailNickname	String	用户的邮件别名。创建用户时必须指定此属性。支持 $filter。
middleName	String	用户的中间名。
mobilePhone	String	用户的主要移动电话号码。
onPremisesInfo	educationOnPremisesInfo	用于将用户与 active Directory AAD关联的其他信息。
passwordPolicies	String	指定用户的密码策略。 此值是一个枚举，具有一个可能值 “DisableStrongPassword”，允许指定比默认策略弱的密码。 还可以指定 “DisablePasswordExpiration”。 可以同时指定两个值；例如：“DisablePasswordExpiration、DisableStrongPassword”。
passwordProfile	passwordProfile	指定用户的密码配置文件。配置文件包含用户的密码。创建用户时此属性是必需的。配置文件中的密码必须满足 passwordPolicies 属性指定的最低要求。默认情况下，必须使用强密码。
preferredLanguage	String	用户的首选语言。 应遵循 ISO 639-1 代码；例如“en-US”。
primaryRole	educationUserRole	用户的默认角色。 用户的角色在各课程中可能有所不同。 可取值为：student、teacher、none、unknownFutureValue。
provisionedPlans	provisionedPlan 集合	为用户设置的计划。只读。不可为 null。
residenceAddress	physicalAddress	用户所在的地址。
student	educationStudent	如果主要角色为学生，此部分将包含特定于学生的数据。
surname	String	用户的姓氏。支持 $filter。
teacher	educationTeacher	如果主要角色是教师，则此块将包含特定于教师的数据。
usageLocation	String	两个字母组成的国家/地区代码（ISO 标准 3166）。 鉴于检查服务在国家/地区的可用性的法律要求，这对将分配许可证的用户而言是必需的。 示例包括：“US”、“JP”和“GB”。 不可为 null。 支持 $filter。
userPrincipalName	String	用户的用户主体名称 (UPN)。
userType	String	可用于对目录中的用户类型分类的字符串值，例如“成员”和“访客”。支持 $filter。

响应

如果成功，此方法会在响应正文中返回 200 OK 响应代码和更新的 educationUser 对象。

示例

请求

下面是一个请求示例。

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#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

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

await graphClient.Education.Users["{educationUser-id}"]
    .Request()
    .UpdateAsync(educationUser);

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 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);

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/education/users/{user-id}"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphEducationUser *educationUser = [[MSGraphEducationUser alloc] init];
[educationUser setDisplayName:@"Rogelio Cazares"];
[educationUser setGivenName:@"Rogelio"];
[educationUser setMiddleName:@"Fernando"];
[educationUser setSurname:@"Cazares"];

NSError *error;
NSData *educationUserData = [educationUser getSerializedDataWithError:&error];
[urlRequest setHTTPBody:educationUserData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

EducationUser educationUser = new EducationUser();
educationUser.displayName = "Rogelio Cazares";
educationUser.givenName = "Rogelio";
educationUser.middleName = "Fernando";
educationUser.surname = "Cazares";

graphClient.education().users("{user-id}")
    .buildRequest()
    .patch(educationUser);

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewEducationUser()
displayName := "Rogelio Cazares"
requestBody.SetDisplayName(&displayName)
givenName := "Rogelio"
requestBody.SetGivenName(&givenName)
middleName := "Fernando"
requestBody.SetMiddleName(&middleName)
surname := "Cazares"
requestBody.SetSurname(&surname)
educationUserId := "educationUser-id"
graphClient.Education().UsersById(&educationUserId).Patch(requestBody)

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.Education

$params = @{
    DisplayName = "Rogelio Cazares"
    GivenName = "Rogelio"
    MiddleName = "Fernando"
    Surname = "Cazares"
}

Update-MgEducationUser -EducationUserId $educationUserId -BodyParameter $params

有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息，请参阅 SDK 文档。

响应

这是一个示例响应。注意：为提高可读性，可能缩短了此处显示的响应对象。

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