educationUser プロパティを更新するUpdate educationUser properties

educationuser オブジェクトのプロパティを更新します。Update the properties of an educationuser object.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) サポートされていません。Not supported.
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication EduRoster.ReadWrite.AllEduRoster.ReadWrite.All

HTTP 要求HTTP request

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

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。In the request body, supply the values for relevant fields that should be updated. 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。For best performance, don't include existing values that haven't changed.

プロパティProperty Type 説明Description
displayNamedisplayName 文字列String ユーザーの表示名Display Name of User
givenNamegivenName StringString First Name
middleNamemiddleName StringString ユーザーのミドル ネームMiddle Name of user
surnamesurname StringString ユーザーの姓Surname of user
mailmail StringString メール アドレスemail address
mobilePhonemobilePhone StringString ユーザーの携帯電話番号Mobile number of user
externalSourceexternalSource stringstring 使用可能な値: sismanualenum_sentinelThe possible values are: sis, manual, enum_sentinel.
externalSourceexternalSource stringstring このユーザーが作成された場所。Where this user was created from. 使用可能な値: sismanualenum_sentinelThe possible values are: sis, manual, enum_sentinel.
mailingAddressmailingAddress physicalAddressphysicalAddress ユーザーのメール アドレス。Mail address of user.
residenceAddressresidenceAddress physicalAddressphysicalAddress ユーザーが在住している場所のアドレス。Address where user lives.
primaryRoleprimaryRole stringstring ユーザーの既定のロール。Default Role for a user. ユーザーのロールは、個々のクラスで異なる場合があります。The user's role might be different in an individual class. 使用可能な値: studentteacherenum_sentinelThe possible values are: student, teacher, enum_sentinel.
studentstudent educationStudenteducationStudent プライマリ ロールが学生の場合、このブロックには学生固有のデータが含まれます。If the primary role is student, this block will contain student specific data.
teacherteacher educationTeachereducationTeacher プライマリ ロールが教師の場合、このブロックには教師固有のデータが含まれます。If the primary role is teacher, this block will conatin teacher specific data.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された educationUser オブジェクトを返します。If successful, this method returns a 200 OK response code and updated educationUser object in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

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

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

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "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": "student",
  "residenceAddress": {
        "city": "Los Angeles",
        "countryOrRegion": "United States",
        "postalCode": "98055",
        "state": "CA",
        "street": "12345 Main St."
      },
  "student": {
      "externalId": "13005",
      "birthDate": "2001-01-01T00:00:00Z"
    }
}

SDK サンプルコードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

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

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

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.