educationUser 资源类型
命名空间:microsoft.graph
重要
Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
系统中的用户。 这是标准[用户]资源的特定于教育的变体,与 Microsoft Graph 从非教育特定/users终结点返回的变体相同id。
此对象提供来自核心[用户]对象的有针对性的属性子集,并添加了一组特定于教育的属性,例如primaryRole,teacher``student
Methods
| 方法 | 返回类型 | 说明 |
|---|---|---|
| Get educationUser | educationUser | 读取 educationUser 对象的属性和关系。 |
| List classes | educationClass 集合 | 获取 educationClass 对象集合,用户是该集合的成员。 |
| List schools | educationSchool 集合 | 获取 educationSchool 对象集合,用户是该集合的成员。 |
| Get user | user | 获取与此 educationUser 对应的简单目录 user。 |
| Update | educationUser | 更新 educationUser 对象。 |
| Delete | 无 | 删除 educationUser 对象。 |
| Delta | educationUser 集合 | 获取 educationUsers 的增量更改。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| id | String | 用户的唯一标识符。继承自 directoryObject。键。不可为 null。只读。 |
| accountEnabled | Boolean | 如果帐户已启用,则为 true;否则,为 false。 创建用户时此属性是必需的。 支持 $筛选器。 |
| assignedLicenses | assignedLicense collection | 分配给该用户的许可证。不可为 null。 |
| assignedPlans | assignedPlan collection | 分配给该用户的计划。只读。不可为 null。 |
| businessPhones | String collection | 用户的电话号码。 注意: 虽然这是字符串集合,但是只能为该属性设置一个号码。 |
| createdBy | identitySet | 创建了用户的实体。 |
| department | String | 用户工作部门的名称。 支持 $筛选器。 |
| displayName | String | 用户通讯簿中显示的名称。 支持 $filter 和 $orderby。 |
| externalSource | String | 此资源的外部源的类型是从) 自动确定 externalSourceDetail 的 (生成的。 可能的值为: sis、 lms或 manual。 |
| externalSourceDetail | 字符串 | 从中生成此资源的外部源的名称。 |
| givenName | String | 用户的名。 支持 $筛选器。 |
| 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 | 用户的默认角色。 用户的角色在各课程中可能有所不同。 可取值为:student、teacher、faculty。 支持 $筛选器。 |
| provisionedPlans | provisionedPlan 集合 | 为用户设置的计划。只读。不可为 null。 |
| relatedContacts | relatedContact 集合 | 与用户相关的相关记录。 可能的关系是parent, , aide``relative, doctor, guardian``child``other``unknownFutureValue |
| residenceAddress | physicalAddress | 用户所在的地址。 注意: type 资源 postOfficeBox 不受支持 educationUser 。 |
| student | educationStudent | 如果主要角色为学生,此部分将包含特定于学生的数据。 |
| surname | String | 用户的姓氏。 支持 $筛选器。 |
| teacher | educationTeacher | 如果主要角色是教师,则此块将包含教师特定的数据。 |
| usageLocation | String | ISO 3166 Alpha-2) (两个字母的国家/地区代码。 将分配许可证的用户是必需的。 不可为 null。 支持 $筛选器。 |
| userPrincipalName | String | 用户的用户主体名称 (UPN) 。 支持 $filter 和 $orderby。 有关其他详细信息,请参阅标准 [用户] 资源。 |
| userType | String | 可用于对目录中的用户类型分类的字符串值,例如“成员”和“访客”。 支持 $筛选器。 |
重要
使用委派权限范围时,Graph将只返回一组有限的属性:id、、primaryRole、displayName``accountEnabled、givenName、surname、userPrincipalName、、userType、、onPremisesInfo、。 teacher/externalId``student/externalId 如果应用程序需要其他属性,则必须使用应用程序权限范围。
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| assignments | educationAssignment | 用户的分配列表。 可为 NULL。 |
| classes | educationClass 集合 | 用户所属的课程。 可为 NULL。 |
| schools | educationSchool 集合 | 用户所属的学校。 可为 NULL。 |
| taughtClasses | educationClass 集合 | 用户是教师的课程。 |
| rubrics | 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"
}
反馈
提交和查看相关反馈