次の方法で共有


educationUser の更新

名前空間: microsoft.graph

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

要求本文

要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。

プロパティ 説明
accountEnabled ブール型 アカウントが有効な場合は true。それ以外の場合は false。 このプロパティは、ユーザーの作成時に必要です。 $filter をサポートします。
assignedLicenses assignedLicense コレクション ユーザーに割り当てられているライセンス。 null 許容ではありません。
assignedPlans assignedPlan collection ユーザーに割り当てられているプラン。 読み取り専用です。 null 許容ではありません。
businessPhones String collection ユーザーの電話番号。 メモ: 文字列コレクションですが、このプロパティに設定できるのは 1 つの数字のみです。
createdBy identitySet ユーザーを作成したエンティティ。
部署 String ユーザーが働いている部門の名前。 $filter をサポートします。
displayName String アドレス帳に表示されるユーザーの名前。 これは通常、ユーザーの名前、ミドルネームのイニシャル、姓の組み合わせになります。 このプロパティは、ユーザーが作成され、更新中にクリアできない場合に必要です。 $filter および $orderby をサポートします。
externalSource educationExternalSource このユーザーが作成された場所。 可能な値は、sismanual です。
externalSourceDetail String このリソースの生成元となる外部ソースの名前。
givenName String ユーザーの名。 $filter をサポートします。
mail String ユーザーの SMTP アドレス。たとえば、"jeff@contoso.com" です。 読み取り専用です。 $filter をサポートします。
mailingAddress physicalAddress ユーザーのメール アドレス。
mailNickname String ユーザーの電子メール エイリアス。 ユーザーの作成時に、このプロパティを指定する必要があります。 $filter をサポートします。
middleName String ユーザーのミドル ネーム。
mobilePhone String ユーザーの主な携帯電話の番号。
onPremisesInfo educationOnPremisesInfo AAD ユーザーを対応する Active Directory に関連付けるために使用される追加情報。
passwordPolicies String ユーザーのパスワード ポリシーを指定します。 この値は列挙値であり、可能な 1 つの値は "DisableStrongPassword" です。この場合は、既定のポリシーより弱いパスワードを指定できます。 "DisablePasswordExpiration" を指定することもできます。 2 つを一緒に指定できます。例: "DisablePasswordExpiration、DisableStrongPassword"。
passwordProfile passwordProfile ユーザーのパスワード プロファイルを指定します。 プロファイルには、ユーザーのパスワードが含まれています。 このプロパティは、ユーザーの作成時に必要です。 プロファイルにあるパスワードは、passwordPolicies プロパティによって指定されている最小要件を満たす必要があります。 既定では、強力なパスワードが必要です。
preferredLanguage String ユーザーが設定する言語。 ISO 639-1 コードに従う必要があります。例: "en-US"。
primaryRole educationUserRole ユーザーの既定のロール。 ユーザーのロールは、個々のクラスで異なる場合があります。 使用可能な値: studentteachernoneunknownFutureValue
provisionedPlans ProvisionedPlan コレクション ユーザーのために用意されたプラン。 読み取り専用です。 null 許容ではありません。
residenceAddress physicalAddress ユーザーが在住している場所のアドレス。
student educationStudent プライマリ ロールが student の場合、このブロックには学生固有のデータが含まれます。
surname String ユーザーの姓。 $filter をサポートします。
teacher educationTeacher 主な役割が教師の場合、このブロックには教師固有のデータが含まれます。
usageLocation String 2 文字の国コード (ISO 規格 3166) 国や地域におけるサービスの利用可能性を確認することが法的に義務付けられているため、ライセンスを割り当てられるユーザーには必須です。 たとえば、"US"、"JP"、"GB" などです。 null 許容ではありません。 $filter をサポートします。
userPrincipalName String ユーザーのユーザー プリンシパル名 (UPN)。
userType String ディレクトリ内のユーザーの種類を分類するために使用する文字列値 (“Member”、“Guest” など)。 $filter をサポートします。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で更新された educationUser オブジェクトを返します。

要求

次の例は要求を示しています。

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

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

次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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