educationUser リソースの種類

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

システム内のユーザーです。 これは、Microsoft Graphが非教育機関固有のエンドポイントから返すのと同じid、標準[ユーザー] リソースの教育固有/usersのバリアントです。

このオブジェクトは、コア [ユーザー] オブジェクトから対象となるプロパティのサブセットを提供し、教育固有のプロパティのセット (、 などprimaryRole``student) をteacher追加します。

メソッド

メソッド 戻り値の型 説明
Get educationUser educationUser educationUser オブジェクトのプロパティとリレーションシップを読み取ります。
List classes educationClass コレクション ユーザーがメンバーになっている educationClass オブジェクトのコレクションを取得します。
List schools educationSchool コレクション ユーザーがメンバーになっている educationSchool オブジェクトのコレクションを取得します。
Get user user この educationUser に対応する単純なディレクトリ user を取得します。
Update educationUser educationUser オブジェクトを更新します。
Delete なし educationUser オブジェクトを削除します。
差分 educationUser コレクション educationUsers の増分変更を取得します。

プロパティ

プロパティ 説明
id String ユーザーの一意の識別子。directoryObject から継承されます。キー。null 許容ではありません。読み取り専用です。
accountEnabled Boolean アカウントが有効な場合は true。それ以外の場合は false。 このプロパティは、ユーザーの作成時に必要です。 フィルターをサポートしています $。
assignedLicenses assignedLicense collection ユーザーに割り当てられているライセンス。null 許容ではありません。
assignedPlans assignedPlan collection ユーザーに割り当てられているプラン。読み取り専用です。null 許容ではありません。
businessPhones String collection ユーザーの電話番号。 メモ: 文字列コレクションですが、このプロパティに設定できるのは 1 つの数字のみです。
createdBy identitySet ユーザーを作成したエンティティ。
department String ユーザーが働いている部門の名前。 フィルターをサポートしています $。
displayName String アドレス帳に表示されるユーザーの名前。 $filter および $orderby をサポートします。
externalSource String このリソースが生成された外部ソースの種類 (自動的に決定 externalSourceDetail元)。 使用可能な値は、sislmsmanual です。
externalSourceDetail String このリソースが生成された外部ソースの名前。
givenName String ユーザーの名。 フィルターをサポートしています $。
mail String ユーザーの SMTP アドレス (たとえば、"jeff@contoso.onmicrosoft.com")。 読み取り専用。 フィルターをサポートしています $。
mailNickname String ユーザーの電子メール エイリアス。 ユーザーの作成時に、このプロパティを指定する必要があります。 フィルターをサポートしています $。
mailingAddress physicalAddress ユーザーのメール アドレス。 注: type postOfficeBox リソースではサポート educationUser されていません。
middleName String ユーザーのミドル ネーム。
mobilePhone String ユーザーの主な携帯電話の番号。
onPremisesInfo educationOnPremisesInfo AAD ユーザーを Active Directory に関連付けるために使用される追加情報。
passwordPolicies String ユーザーのパスワード ポリシーを指定します。 詳細については、標準 [ユーザー] リソースを参照してください。
passwordProfile passwordProfile ユーザーのパスワード プロファイルを指定します。 プロファイルには、ユーザーのパスワードが含まれています。 このプロパティは、ユーザーの作成時に必要です。 詳細については、標準 [ユーザー] リソースを参照してください。
preferredLanguage String ユーザーが設定する言語。 ISO 639-1 コードに従う必要があります。例: "en-US"。
primaryRole string ユーザーの既定のロール。 ユーザーのロールは、個々のクラスで異なる場合があります。 使用可能な値: studentteacherfaculty。 フィルターをサポートしています $。
provisionedPlans ProvisionedPlan コレクション ユーザーのために用意されたプラン。読み取り専用です。null 許容ではありません。
relatedContacts relatedContact コレクション ユーザーに関連する関連レコード。 可能なリレーションシップはparent、 , , relative, aide, doctor, other``guardian``child,unknownFutureValue
residenceAddress physicalAddress ユーザーが在住している場所のアドレス。 注: type postOfficeBox リソースではサポート educationUser されていません。
student educationStudent プライマリ ロールが学生の場合、このブロックには学生固有のデータが含まれます。
surname String ユーザーの姓。 フィルターをサポートしています $。
teacher educationTeacher プライマリ ロールが教師の場合、このブロックには教師固有のデータが含まれます。
usageLocation String 2 文字の国番号 (ISO 3166 Alpha-2)。 ライセンスが割り当てられるユーザーに必要です。 null 許容ではありません。 フィルターをサポートしています $。
userPrincipalName String ユーザーのユーザー プリンシパル名 (UPN)。 $filter および $orderby をサポートします。 詳細については、標準 [ユーザー] リソースを参照してください。
userType String ディレクトリ内のユーザーの種類を分類するために使用する文字列値 (“Member”、“Guest” など)。 フィルターをサポートしています $。

重要

委任されたアクセス許可スコープを使用する場合、Graphは制限付きのプロパティidセット (, , givenName``surname``userPrincipalName``primaryRole``onPremisesInfo``accountEnabled``teacher/externalId``displayName``userType``student/externalId. アプリケーションに追加のプロパティが必要な場合は、アプリケーションのアクセス許可スコープを使用する必要があります。

リレーションシップ

リレーションシップ 説明
assignments educationAssignment ユーザーの割り当ての一覧。 Null 許容型。
classes educationClass コレクション ユーザーが属しているクラス。 Null 許容型。
schools educationSchool コレクション ユーザーが属している学校。 Null 許容型。
taughtClasses educationClass コレクション ユーザーが教師であるクラス。
ルーブリック educationRubric コレクション 設定すると、割り当てにアタッチされた成績ルーブリックが表示されます。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "accountEnabled": true,
  "assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
  "assignedPlans": [{ "@odata.type": "microsoft.graph.assignedPlan" }],
  "businessPhones": ["String"],
  "createdBy": { "@odata.type": "microsoft.graph.identitySet" },
  "department": "String",
  "displayName": "String",
  "externalSource": "string",
  "givenName": "String",
  "id": "String (identifier)",
  "mail": "String",
  "mailNickname": "String",
  "mailingAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
  "middleName": "String",
  "mobilePhone": "String",
  "officeLocation": "String",
  "onPremisesInfo": {
    "@odata.type": "microsoft.graph.educationOnPremisesInfo"
  },
  "passwordPolicies": "String",
  "passwordProfile": { "@odata.type": "microsoft.graph.passwordProfile" },
  "preferredLanguage": "String",
  "primaryRole": "string",
  "provisionedPlans": [{ "@odata.type": "microsoft.graph.provisionedPlan" }],
  "residenceAddress": { "@odata.type": "microsoft.graph.physicalAddress" },
  "student": { "@odata.type": "microsoft.graph.educationStudent" },
  "surname": "String",
  "teacher": { "@odata.type": "microsoft.graph.educationTeacher" },
  "usageLocation": "String",
  "userPrincipalName": "String",
  "userType": "String"
}