命名空间:microsoft.graph
系统中的用户。 这是用户的特定于教育的变体,其 ID 与 Microsoft Graph 将从非教育特定 /users 终结点返回的 ID 相同。 此对象提供核心 用户 对象中属性的目标子集,并添加一组特定于教育的属性,例如 primaryRole、 学生和 教师 数据。
继承自 entity。
Methods
| 方法 | 返回类型 | Description |
|---|---|---|
| List | educationUser 集合 | 获取 educationUser 对象及其属性的列表。 |
| 创建 | educationUser | 创建新的 educationUser 对象。 |
| Get | educationUser | 读取 educationUser 对象的属性和关系。 |
| 更新 | educationUser | 更新 educationUser 对象的属性。 |
| 删除 | 无 | 删除 educationUser 对象。 |
| 获取对用户的更改 | educationUser 集合 | 获取对资源集合的增量更改。 |
| 列出教学类 | educationClass 集合 | 从 taughtClasses 导航属性获取 educationClass 资源。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| accountEnabled | Boolean | 启用帐户时为 True,否则为 false。 创建用户时此属性是必需的。 支持 $filter。 |
| assignedLicenses | assignedLicense collection | 分配给该用户的许可证。 不可为 null。 |
| assignedPlans | assignedPlan collection | 分配给该用户的计划。 只读。 不可为 null。 |
| businessPhones | String collection | 用户的电话号码。 注意:虽然这是字符串集合,但是只能为该属性设置一个号码。 |
| createdBy | identitySet | 创建用户的实体。 |
| department | String | 用户工作部门的名称。 支持 $filter。 |
| displayName | String | 用户通讯簿中显示的名称。 这通常是用户名字、中间名首字母和姓氏的组合。 此属性在创建用户时是必需的,并且在更新过程中不能清除。 支持 $filter 和 $orderby。 |
| externalSource | educationExternalSource | 创建此用户的位置。 可能的值为: sis、 manual。 |
| externalSourceDetail | String | 从中生成此资源的外部源的名称。 |
| givenName | String | 用户的名。 支持 $filter。 |
| id | String | 对象标识符。 继承自 entity。 |
| 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 | 指定用户的密码策略。 此值表示枚举,其中一个可能 DisableStrongPassword为枚举值,允许指定超过默认策略的密码。
DisablePasswordExpiration 也可以指定 。 两者可以一起指定:例如: 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 | 两个字母组成的国家/地区代码(ISO 标准 3166)。 鉴于检查服务在国家/地区的可用性的法律要求,这对将分配许可证的用户而言是必需的。 示例包括: US、 JP和 GB。 不可为 null。 支持 $filter。 |
| userPrincipalName | String | 用户的用户主体名称 (UPN)。 UPN 是基于 Internet 标准 RFC 822 的用户的 Internet 样式登录名。 按照惯例,此名称应映射到用户的电子邮件名称。 常规格式为 alias@domain,其中域必须存在于租户的已验证域集合中。 创建用户时此属性是必需的。 可以从组织的verifiedDomains 属性访问租户的已验证域。 支持 $filter 和 $orderby。 |
| userType | String | 可用于对目录中的用户类型进行分类的字符串值,例如MemberGuest。 支持 $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"
}