educationUser リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
システム内のユーザーを表します。 このリソースは、標準ユーザー リソースの教育固有のバリアントであり、Microsoft Graph が教育固有/users以外のエンドポイントから返すのと同じですid。
このオブジェクトは、コア ユーザー オブジェクトからプロパティのターゲット サブセットを提供し、 などのprimaryRolestudent教育固有のプロパティのセットをteacher追加します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Get user | educationUser | educationUser オブジェクトのプロパティとリレーションシップを読み取ります。 |
| List classes | educationClass コレクション | ユーザーがメンバーになっている educationClass オブジェクトのコレクションを取得します。 |
| List schools | educationSchool コレクション | ユーザーがメンバーになっている educationSchool オブジェクトのコレクションを取得します。 |
| Get user | user | この educationUser に対応する単純なディレクトリ user を取得します。 |
| Update | educationUser | educationUser オブジェクトを更新します。 |
| Delete user | なし | educationUser オブジェクトを削除します。 |
| Get delta | educationUser コレクション | educationUsers の増分変更を取得します。 |
プロパティ
| プロパティ | 種類 | 説明 |
|---|---|---|
| id | String | ユーザーの一意の識別子。 directoryObject から継承されます。 キー。 null 許容ではありません。 読み取り専用です。 |
| accountEnabled | ブール型 | アカウントが有効な場合は true。それ以外の場合は false。 このプロパティは、ユーザーの作成時に必要です。 $filter をサポートします。 |
| assignedLicenses | assignedLicense コレクション | ユーザーに割り当てられているライセンス。 null 許容ではありません。 |
| assignedPlans | assignedPlan collection | ユーザーに割り当てられているプラン。 読み取り専用です。 null 許容ではありません。 |
| businessPhones | String collection | ユーザーの電話番号。 メモ: 文字列コレクションですが、このプロパティに設定できるのは 1 つの数字のみです。 |
| createdBy | identitySet | ユーザーを作成したエンティティ。 |
| 部署 | String | ユーザーが働いている部門の名前。 $filter をサポートします。 |
| displayName | String | アドレス帳に表示されるユーザーの名前。 $filter および $orderby をサポートします。 |
| externalSource | String | このリソースが生成された外部ソースの種類 (から自動的に決定されます externalSourceDetail)。 使用可能な値は、sis、lms、manual です。 |
| externalSourceDetail | String | このリソースが生成された外部ソースの名前。 |
| givenName | String | ユーザーの名。 $filter をサポートします。 |
| String | ユーザーの SMTP アドレス。たとえば、"jeff@contoso.com" です。 読み取り専用です。 $filter をサポートします。 | |
| mailNickname | String | ユーザーの電子メール エイリアス。 ユーザーの作成時に、このプロパティを指定する必要があります。 $filter をサポートします。 |
| mailingAddress | physicalAddress | ユーザーのメール アドレス。 注: type と postOfficeBox は、リソースでは educationUser サポートされていません。 |
| middleName | String | ユーザーのミドル ネーム。 |
| mobilePhone | String | ユーザーの主な携帯電話の番号。 |
| officeLocation | String | ユーザーのオフィスの場所。 |
| onPremisesInfo | educationOnPremisesInfo | Microsoft Entra ユーザーを対応する Active Directory に関連付けるために使用される追加情報。 |
| passwordPolicies | String | ユーザーのパスワード ポリシーを指定します。 詳細については、標準 ユーザー リソースに関するページを参照してください。 |
| passwordProfile | passwordProfile | ユーザーのパスワード プロファイルを指定します。 プロファイルには、ユーザーのパスワードが含まれています。 このプロパティは、ユーザーの作成時に必要です。 詳細については、標準 ユーザー リソースに関するページを参照してください。 |
| preferredLanguage | String | ユーザーが設定する言語。 ISO 639-1 コードに従う必要があります。例: "en-US"。 |
| primaryRole | string | ユーザーの既定のロール。 ユーザーのロールは、個々のクラスで異なる場合があります。 使用可能な値: student、teacher、faculty。 $filter をサポートします。 |
| provisionedPlans | ProvisionedPlan コレクション | ユーザーのために用意されたプラン。 読み取り専用です。 null 許容ではありません。 |
| relatedContacts | relatedContact コレクション | ユーザーに関連する関連レコード。 可能なリレーションシップは parent、、 relative、、 aide、 doctor、 guardian、 child、 otherです。 unknownFutureValue |
| residenceAddress | physicalAddress | ユーザーが在住している場所のアドレス。 注: type と postOfficeBox は、リソースでは educationUser サポートされていません。 |
| student | educationStudent | プライマリ ロールが student の場合、このブロックには学生固有のデータが含まれます。 |
| surname | String | ユーザーの姓。 $filter をサポートします。 |
| teacher | educationTeacher | 主な役割が教師の場合、このブロックには教師固有のデータが含まれます。 |
| usageLocation | String | 2 文字の国コード (ISO 3166 Alpha-2)。 ライセンスが割り当てられているユーザーに必要です。 null 許容ではありません。 $filter をサポートします。 |
| userPrincipalName | String | ユーザーのユーザー プリンシパル名 (UPN)。 $filter および $orderby をサポートします。 詳細については、標準 ユーザー リソースに関するページを参照してください。 |
| userType | String | ディレクトリ内のユーザーの種類を分類するために使用する文字列値 (“Member”、“Guest” など)。 $filter をサポートします。 |
重要
委任されたアクセス許可スコープを使用する場合、Graph では、 の一連のプロパティidaccountEnabledonPremisesInfostudent/externalIdprimaryRolegivenNameteacher/externalIddisplayNamesurnameuserPrincipalNameuserTypeのみが返されます。 アプリケーションで追加のプロパティが必要な場合は、アプリケーションのアクセス許可スコープを使用する必要があります。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| 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"
}