名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
educationuser オブジェクトのプロパティを更新します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
❌ |
❌ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
サポートされていません。 |
サポートされていません。 |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
EduRoster.ReadWrite.All |
注意事項なし。 |
HTTP 要求
PATCH /education/me
PATCH /education/users/{id}
| ヘッダー |
値 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を保持するか、他のプロパティ値の変更に基づいて再計算されます。 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。
| プロパティ |
型 |
説明 |
| displayName |
String |
ユーザーの表示名 |
| givenName |
String |
名 |
| middleName |
String |
ユーザーのミドル ネーム |
| surname |
String |
ユーザーの姓 |
| mail |
String |
メール アドレス |
| mobilePhone |
String |
モバイルユーザー数 |
| externalSource |
string |
このユーザーが作成された場所。 使用可能な値は、 sis、 manual、または lmsです。 |
| mailingAddress |
physicalAddress |
ユーザーのメール アドレス。 注: educationUser リソースでは、typeとpostOfficeBoxはサポートされていません。 |
| residenceAddress |
physicalAddress |
ユーザーが在住している場所のアドレス。 注: educationUser リソースでは、typeとpostOfficeBoxはサポートされていません。 |
| primaryRole |
string |
ユーザーの既定のロール。 ユーザーのロールは、個々のクラスで異なる場合があります。 使用可能な値: student、teacher、enum_sentinel。 |
| student |
educationStudent |
プライマリ ロールが student の場合、このブロックには学生固有のデータが含まれます。 |
| teacher |
educationTeacher |
主な役割が教師の場合、このブロックには教師固有のデータが含まれます。 |
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された educationUser オブジェクトを返します。
例
要求
次の例は要求を示しています。
PATCH https://graph.microsoft.com/beta/education/users/13020
Content-type: application/json
{
"displayName": "Rogelio Cazares",
"givenName": "Rogelio",
"middleName": "Fernando",
"surname": "Cazares",
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.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);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-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)
// 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);
const options = {
authProvider,
};
const client = Client.init(options);
const educationUser = {
displayName: 'Rogelio Cazares',
givenName: 'Rogelio',
middleName: 'Fernando',
surname: 'Cazares',
};
await client.api('/education/users/13020')
.version('beta')
.update(educationUser);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\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();
Import-Module Microsoft.Graph.Beta.Education
$params = @{
displayName = "Rogelio Cazares"
givenName = "Rogelio"
middleName = "Fernando"
surname = "Cazares"
}
Update-MgBetaEducationUser -EducationUserId $educationUserId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.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)
応答
次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
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"
}
}