educationUser リソースの種類

2024-07-22

名前空間: microsoft.graph

システム内のユーザーです。これは、Microsoft Graph が教育以外の/users エンドポイントから返す ID と同じ ID を持つユーザーの教育固有のバリアントです。このオブジェクトは、コアユーザーオブジェクトからプロパティのターゲットサブセットを提供し、 primaryRole、 student、 teacher データなどの教育固有のプロパティのセットを追加します。

エンティティから継承します。

メソッド

メソッド	戻り値の種類	説明
List	educationUser コレクション	educationUser オブジェクトとそのプロパティの一覧を取得します。
Create	educationUser	新しい educationUser オブジェクトを作成します。
Get	educationUser	educationUser オブジェクトのプロパティとリレーションシップを読み取ります。
Update	educationUser	educationUser オブジェクトのプロパティを更新します。
Delete	なし	educationUser オブジェクトを削除します。
ユーザーへの変更を取得する	educationUser コレクション	リソースコレクションに対する増分変更を取得します。
教えたクラスを一覧表示する	educationClass コレクション	taughtClasses ナビゲーションプロパティから educationClass リソースを取得します。

プロパティ

プロパティ	型	説明
accountEnabled	Boolean	アカウントが有効な場合は `True` であり、それ以外の場合は `false` です。このプロパティは、ユーザーの作成時に必要です。 `$filter` をサポートしています。
assignedLicenses	assignedLicense コレクション	ユーザーに割り当てられているライセンス。 null 許容ではありません。
assignedPlans	assignedPlan collection	ユーザーに割り当てられているプラン。読み取り専用です。 null 許容ではありません。
businessPhones	String collection	ユーザーの電話番号。メモ: 文字列コレクションですが、このプロパティに設定できるのは 1 つの数字のみです。
createdBy	identitySet	ユーザーを作成したエンティティ。
department	String	ユーザーが働いている部門の名前。 `$filter` をサポートしています。
displayName	String	アドレス帳に表示されるユーザーの名前。これは通常、ユーザーの名前、ミドルネームのイニシャル、姓の組み合わせになります。このプロパティはユーザーの作成時に必須です。更新時にクリアすることはできません。 `$filter` と `$orderby` をサポートします。
externalSource	educationExternalSource	このユーザーが作成された場所。可能な値は、`sis`、`manual` です。
externalSourceDetail	String	このリソースが生成された外部ソースの名前。
givenName	String	ユーザーの名。 `$filter` をサポートしています。
id	String	オブジェクト識別子。エンティティから継承されます。
mail	String	ユーザーの SMTP アドレス (たとえば、`jeff@contoso.com`)。読み取り専用です。 `$filter` をサポートします。
mailingAddress	physicalAddress	ユーザーのメールアドレス。
mailNickname	String	ユーザーの電子メールエイリアス。ユーザーの作成時に、このプロパティを指定する必要があります。 `$filter` をサポートしています。
middleName	String	ユーザーのミドルネーム。
mobilePhone	String	ユーザーの主な携帯電話の番号。
officeLocation	String	ユーザーのオフィスの場所。
onPremisesInfo	educationOnPremisesInfo	Microsoft Entra ユーザーを対応する Active Directory に関連付けるために使用される追加情報。
passwordPolicies	String	ユーザーのパスワードポリシーを指定します。この値は列挙値であり、可能な 1 つの値は `DisableStrongPassword` です。この場合は、既定のポリシーより弱いパスワードを指定できます。 `DisablePasswordExpiration` を指定することもできます。 2 つを一緒に指定できます。例: `DisablePasswordExpiration, DisableStrongPassword`。
passwordProfile	passwordProfile	ユーザーのパスワードプロファイルを指定します。プロファイルには、ユーザーのパスワードが含まれています。このプロパティは、ユーザーの作成時に必要です。プロファイルにあるパスワードは、passwordPolicies プロパティによって指定されている最小要件を満たす必要があります。既定では、強力なパスワードが必要です。
preferredLanguage	String	ISO 639-1 コードに従うユーザーに適した言語 (たとえば、 `en-US`)。
primaryRole	educationUserRole	ユーザーの既定のロール。ユーザーのロールは、個々のクラスで異なる場合があります。使用可能な値: `student`、`teacher`、`none`、`unknownFutureValue`。
provisionedPlans	ProvisionedPlan コレクション	ユーザーのために用意されたプラン。読み取り専用です。 null 許容ではありません。
refreshTokensValidFromDateTime	DateTimeOffset	この時点よりも前に発行された更新トークンやセッショントークン (セッション Cookie) はすべて無効であり、アプリケーションが無効な更新トークンやセッショントークンを使用して (Microsoft Graph などの API にアクセスする目的で) 代理アクセストークンを取得しようとすると、エラーが発生します。この状況が発生した場合、アプリケーションは承認されたエンドポイントを要求して、新しい更新トークンを取得する必要があります。 `$select` でのみ返されます。読み取り専用です。
relatedContacts	relatedContact コレクション	ユーザーに関連付けられている関連レコード。読み取り専用です。
residenceAddress	physicalAddress	ユーザーが住んでいるアドレス。
showInAddressList	Boolean	`True` Outlook グローバルアドレス一覧にこのユーザーが含まれている必要がある場合。それ以外の場合は、 `false`。設定されていない場合は、`true` として扱われます。招待マネージャーから招待されたユーザーの場合、このプロパティは `false` に設定されます。
student	educationStudent	プライマリロールが学生の場合、このブロックには学生固有のデータが含まれます。
surname	String	ユーザーの姓。 `$filter` をサポートしています。
teacher	educationTeacher	主な役割が教師の場合、このブロックには教師固有のデータが含まれます。
usageLocation	String	2 文字の国コード (ISO 規格 3166) 国や地域におけるサービスの利用可能性を確認することが法的に義務付けられているため、ライセンスを割り当てられるユーザーには必須です。たとえば、`US`、`JP`、`GB` などがあります。 null 許容ではありません。 `$filter` をサポートしています。
userPrincipalName	String	ユーザーのユーザープリンシパル名 (UPN)。 UPN は、インターネット標準 RFC 822 に基づくユーザーのインターネットスタイルのログイン名です。規則では、これはユーザーの電子メール名にマップされる必要があります。一般的な形式は `alias@___domain`で、検証済みドメインのテナントのコレクションにドメインが存在する必要があります。このプロパティは、ユーザーの作成時に必要です。テナントの検証済みドメインには、組織の verifiedDomains プロパティからアクセスできます。 `$filter` と `$orderby` をサポートします。
userType	String	ディレクトリ内のユーザーの種類を分類するために使用する文字列値 (`Member`、`Guest` など)。 `$filter` をサポートします。

重要

委任されたアクセス許可スコープを使用する場合、Microsoft Graph は、id、primaryRole、accountEnabled、displayName、givenName、surname、userPrincipalName、userType、onPremisesInfo、student/externalId、teacher/externalId という限られたプロパティセットのみを返します。アプリケーションで追加のプロパティが必要な場合は、アプリケーションのアクセス許可スコープを使用する必要があります。

リレーションシップ

リレーションシップ	型	説明
assignments	educationAssignment コレクション	ユーザーに属する割り当て。
classes	educationClass コレクション	ユーザーが属しているクラス。 Null 許容型。
schools	educationSchool コレクション	ユーザーが属している学校。 Null 許容型。
taughtClasses	educationClass コレクション	ユーザーが教師であるクラス。
ユーザー	user	このユーザーに対応するディレクトリユーザー。
ルーブリック	educationRubric コレクション	設定すると、課題にアタッチされたグレーディングルーブリックが設定されます。

JSON 表記

次の JSON 表現は、リソースの種類を示しています。

{
  "@odata.type": "#microsoft.graph.educationUser",
  "accountEnabled": "Boolean",
  "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",
  "externalSourceDetail": "String",
  "givenName": "String",
  "id": "String (identifier)",
  "mail": "String",
  "mailingAddress": {
    "@odata.type": "microsoft.graph.physicalAddress"
  },
  "mailNickname": "String",
  "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"
    }
  ],
  "refreshTokensValidFromDateTime": "String (timestamp)",
  "residenceAddress": {
    "@odata.type": "microsoft.graph.physicalAddress"
  },
  "showInAddressList": "Boolean",
  "student": {
    "@odata.type": "microsoft.graph.educationStudent"
  },
  "surname": "String",
  "teacher": {
    "@odata.type": "microsoft.graph.educationTeacher"
  },
  "usageLocation": "String",
  "userPrincipalName": "String",
  "userType": "String"
}

フィードバック

このページはお役に立ちましたか?