educationUser リソースの種類educationUser resource type

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

システム内のユーザーです。A user in the system. これは教育機関に固有の、Microsoft Graph が教育機関に固有でない /users エンドポイントから返すものと同じ id を持つユーザーのバリアント型です。This is an education-specific variant of the user with the same id that Microsoft Graph will return from the non-education-specific /users endpoint. このオブジェクトは、コア user オブジェクトから対象のサブセットのプロパティを提供し、primaryRole、学生、教師データなど教育機関に固有のプロパティのセットを追加します。This object provides a targeted subset of properties from the core user object and adds a set of education-specific properties such as primaryRole, student, and teacher data.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
Get educationUserGet educationUser educationUsereducationUser educationUser オブジェクトのプロパティとリレーションシップを読み取ります。Read properties and relationships of an educationUser object.
List classesList classes educationClass コレクションeducationClass collection ユーザーがメンバーになっている educationClass オブジェクトのコレクションを取得します。Get the educationClass object collection for which the user is member.
List schoolsList schools educationSchool コレクションeducationSchool collection ユーザーがメンバーになっている educationSchool オブジェクトのコレクションを取得します。Get the educationSchool object collection for which the user is a member.
Get userGet user useruser この educationUser に対応する単純なディレクトリ user を取得します。Get the simple directory user that corresponds to this educationUser.
UpdateUpdate educationUsereducationUser educationUser オブジェクトを更新します。Update an educationUser object.
DeleteDelete NoneNone educationUser オブジェクトを削除します。Delete an educationUser object.
差分Delta educationUser コレクションeducationUser collection EducationUsersの増分の変更を取得します。Get incremental changes for educationUsers.

プロパティProperties

プロパティProperty Type 説明Description
idid 文字列String ユーザーの一意の識別子。directoryObject から継承されます。キー。null 許容ではありません。読み取り専用です。The unique identifier for the user. Inherited from directoryObject. Key. Not nullable. Read-only.
accountEnabledaccountEnabled BooleanBoolean アカウントが有効な場合は true。それ以外の場合は falseTrue if the account is enabled; otherwise, false. このプロパティは、ユーザーの作成時に必要です。This property is required when a user is created. フィルター $をサポートします。Supports $filter.
assignedLicensesassignedLicenses assignedLicense collectionassignedLicense collection ユーザーに割り当てられているライセンス。null 許容ではありません。The licenses that are assigned to the user. Not nullable.
assignedPlansassignedPlans assignedPlan collectionassignedPlan collection ユーザーに割り当てられているプラン。読み取り専用です。null 許容ではありません。The plans that are assigned to the user. Read-only. Not nullable.
businessPhonesbusinessPhones String collectionString collection ユーザーの電話番号。The telephone numbers for the user. メモ: 文字列コレクションですが、このプロパティに設定できるのは 1 つの数字のみです。Note: Although this is a string collection, only one number can be set for this property.
createdBycreatedBy identitySetidentitySet ユーザーを作成したエンティティ。Entity who created the user.
departmentdepartment StringString ユーザーが働いている部門の名前。The name for the department in which the user works. フィルター $をサポートします。Supports $filter.
displayNamedisplayName 文字列型 (String)String アドレス帳に表示されるユーザーの名前。The name displayed in the address book for the user. これは通常、ユーザーの名前、ミドルネームのイニシャル、姓の組み合わせになります。This is usually the combination of the user's first name, middle initial, and last name. このプロパティはユーザーの作成時に必須です。更新時にクリアすることはできません。This property is required when a user is created and it cannot be cleared during updates. $filter および $orderby をサポートします。Supports $filter and $orderby.
externalSourceexternalSource educationExternalSource このユーザーが作成された場所。Where this user was created from. 使用可能な値: sis または manualPossible values are: sis or manual.
givenNamegivenName StringString ユーザーの名。The given name (first name) of the user. フィルター $をサポートします。Supports $filter.
mailmail StringString ユーザーの SMTP アドレス (たとえば、"jeff@contoso.onmicrosoft.com")。The SMTP address for the user; for example, "jeff@contoso.onmicrosoft.com". 読み取り専用。Read-Only. フィルター $をサポートします。Supports $filter.
mailNicknamemailNickname StringString ユーザーの電子メール エイリアス。The mail alias for the user. ユーザーの作成時に、このプロパティを指定する必要があります。This property must be specified when a user is created. フィルター $をサポートします。Supports $filter.
mailingAddressmailingAddress physicalAddressphysicalAddress ユーザーのメール アドレス。Mail address of user.
middleNamemiddleName StringString ユーザーのミドル ネーム。The middle name of user.
mobilePhonemobilePhone StringString ユーザーの主な携帯電話の番号。The primary cellular telephone number for the user.
onPremisesInfoonPremisesInfo educationOnPremisesInfoeducationOnPremisesInfo AAD ユーザーを Active Directory に対応させるために使用される追加情報。Additional information used to associate the AAD user with it's Active Directory counterpart.
passwordPoliciespasswordPolicies StringString ユーザーのパスワード ポリシーを指定します。Specifies password policies for the user. この値は列挙値であり、可能な 1 つの値は "DisableStrongPassword" です。この場合は、既定のポリシーより脆弱なパスワードを指定できます。This value is an enumeration with one possible value being “DisableStrongPassword”, which allows weaker passwords than the default policy to be specified. "DisablePasswordExpiration" を指定することもできます。“DisablePasswordExpiration” can also be specified. 2 つを一緒に指定できます。例: "DisablePasswordExpiration、DisableStrongPassword"。The two can be specified together; for example: "DisablePasswordExpiration, DisableStrongPassword".
passwordProfilepasswordProfile passwordProfilepasswordProfile ユーザーのパスワード プロファイルを指定します。プロファイルには、ユーザーのパスワードが含まれています。このプロパティは、ユーザーの作成時に必要です。プロファイルにあるパスワードは、passwordPolicies プロパティによって指定されている最小要件を満たす必要があります。既定では、強力なパスワードが必要です。Specifies the password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required.
preferredLanguagepreferredLanguage StringString ユーザーが設定する言語。The preferred language for the user. ISO 639-1 コードに従う必要があります。例: "en-US"。Should follow ISO 639-1 Code; for example, "en-US".
primaryRoleprimaryRole stringstring ユーザーの既定のロール。Default role for a user. ユーザーのロールは、個々のクラスで異なる場合があります。The user's role might be different in an individual class. 使用可能な値: studentteacherfacultyPossible values are: student, teacher, faculty. フィルター $をサポートします。Supports $filter.
provisionedPlansprovisionedPlans provisionedPlanコレクションprovisionedPlan collection ユーザーのために用意されたプラン。読み取り専用です。null 許容ではありません。The plans that are provisioned for the user. Read-only. Not nullable.
residenceAddressresidenceAddress physicalAddressphysicalAddress ユーザーが在住している場所のアドレス。Address where user lives.
studentstudent educationStudenteducationStudent プライマリ ロールが学生の場合、このブロックには学生固有のデータが含まれます。If the primary role is student, this block will contain student specific data.
surnamesurname StringString ユーザーの姓。The user's surname (family name or last name). フィルター $をサポートします。Supports $filter.
teacherteacher educationTeachereducationTeacher プライマリロールが教師の場合、このブロックには教師固有のデータが含まれます。If the primary role is teacher, this block will contain teacher specific data.
usageLocationusageLocation StringString 2 文字の国コード (ISO 規格 3166)A two-letter country code (ISO standard 3166). 国や地域におけるサービスの利用可能性を確認することが法的に義務付けられているため、ライセンスを割り当てられるユーザーには必須です。Required for users who will be assigned licenses due to a legal requirement to check for availability of services in countries or regions. たとえば、"US"、"JP"、"GB" などです。Examples include: "US", "JP", and "GB". null 許容ではありません。Not nullable. フィルター $をサポートします。Supports $filter.
userPrincipalNameuserPrincipalName StringString ユーザーのユーザー プリンシパル名 (UPN)。UPN は、インターネット標準 RFC 822 に基づいた、インターネット スタイルのユーザーのログイン名です。規則では、これはユーザーの電子メール名にマップされる必要があります。一般的な形式は alias@domain です。このドメインは、検証済みドメインのテナントのコレクション内に存在している必要があります。このプロパティは、ユーザーの作成時に必要です。テナントの検証済みのドメインには、organizationverifiedDomains プロパティからアクセスできます。$filter および $orderby をサポートします。The user principal name (UPN) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. Supports $filter and $orderby.
userTypeuserType StringString ディレクトリ内のユーザーの種類を分類するために使用する文字列値 (“Member”、“Guest” など)。A string value that can be used to classify user types in your directory, such as “Member” and “Guest”. フィルター $をサポートします。Supports $filter.

重要

委任されたアクセス許可スコープを使用する場合、Graph は限られidprimaryRoleプロパティaccountEnabledセットdisplayNameのみgivenNamesurname返しuserPrincipalNameますuserType: onPremisesInfo、、、、、、、、。When using Delegated permission scopes, Graph will only return a limited set of properties: id, primaryRole, accountEnabled, displayName, givenName, surname, userPrincipalName, userType, onPremisesInfo. アプリケーションで追加のプロパティが必要な場合は、アプリケーションのアクセス許可スコープを使用する必要があります。If your application requires additional properties, you must use Application permission scopes.

リレーションシップRelationships

リレーションシップRelationship Type 説明Description
assignmentsassignments educationAssignmenteducationAssignment ユーザーの割り当てのリスト。List of assignments for the user. Null 許容型。Nullable.
classesclasses educationClass コレクションeducationClass collection ユーザーが属しているクラス。Classes to which the user belongs. Null 許容型。Nullable.
schoolsschools educationSchool コレクションeducationSchool collection ユーザーが属している学校。Schools to which the user belongs. Null 許容型。Nullable.
taughtClassestaughtClasses educationClass コレクションeducationClass collection ユーザーが教師であるクラス。Classes for which the user is a teacher.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。The following is a JSON representation of the resource.

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