用户资源类型
命名空间:microsoft.graph
表示Microsoft Entra用户帐户。 此资源是允许传入其他属性的开放类型。 继承自 directoryObject。
默认情况下,在 v1.0 中仅返回一部分用户属性。 若要检索其他属性,必须在查询选项中 $select
指定它们。
该资源支持:
方法
方法 | 返回类型 | Description |
---|---|---|
List | user 集合 | 获取用户对象列表。 |
创建 | user | 新建用户对象。 |
Get | user | 读取 user 对象的属性和关系。 |
更新 | user | 更新 user 对象。 |
删除 | None | 删除 user 对象。 |
获取增量 | user 集合 | 获取用户的增量更改。 |
更改密码 | 无 | 更新自己的密码。 |
重试服务预配 | None | 重试用户服务预配。 |
撤销登录会话 | 无 | 通过将 signInSessionsValidFromDateTime 用户属性重置为当前的日期时间来吊销向应用程序发出的用户的所有刷新和会话令牌。 它会强制用户再次登录到这些应用程序。 |
导出个人数据 | 无 | 提交公司管理员发出的数据策略操作请求,以导出组织用户的数据。 |
应用角色分配 | ||
List | appRoleAssignment 集合 | 获取分配给此用户的应用和应用角色。 |
添加 | appRoleAssignment | 为此用户分配应用角色。 |
Remove | 无 | 删除分配给此用户的应用角色。 |
Calendar | ||
List calendars | calendar 集合 | 获取 Calendar 对象集合。 |
Create calendar | Calendar | 通过发布到日历集合创建新日历。 |
列出日历组 | calendarGroup 集合 | 获取 CalendarGroup 对象集合。 |
创建日历组 | CalendarGroup | 通过发布到 calendarGroups 集合新建 CalendarGroup。 |
List events | event 集合 | 获取用户邮箱中的 event 对象列表。 该列表包含单个实例会议和系列主控形状。 |
Create event | event | 通过发布到事件集合新建事件。 |
查找会议时间 | meetingTimeSuggestionsResult | 基于与会者忙闲状态、位置或时间限制查找会议时间和位置。 |
获取忙/闲日程安排 | scheduleInformation | 获取指定时间段内) 的用户、通讯组列表或资源集合 (会议室或设备的忙/闲可用性信息。 |
列出日历视图 | event 集合 | 获取 event 对象集合。 |
提醒视图 | Reminder collection | 返回指定开始时间和结束时间范围内的日历提醒列表。 |
委派权限授予 | ||
列出委托的权限授予 | oAuth2PermissionGrant 集合 | 检索授予的委托权限列表,使客户端应用程序能够代表用户访问 API。 |
目录对象 | ||
按 ID 获取 | 字符串集合 | 返回 ID 列表中指定的目录对象。 |
获取目录对象的增量 | directoryObject collection | 获取目录对象(例如用户、组、应用程序和服务主体)的增量更改。 需要对派生类型的 ID 或派生类型本身进行筛选。 有关增量查询的详细信息,请参阅 使用增量查询跟踪 Microsoft Graph 数据中的更改。 |
检查成员组 | String collection | 检查组列表中的成员身份。 检查是可传递的。 |
获取成员组 | String collection | 返回用户是其成员的所有组。 检查是可传递的。 |
检查成员对象 | String 集合 | 检查组、目录角色或管理单元对象列表中的成员身份。 此函数可传递。 |
获取成员对象 | String collection | 返回用户所属的所有组、管理单元和目录角色。 检查是可传递的。 |
列出创建的对象 | directoryObject collection | 从 createdObjects 导航属性中获取此用户创建的目录对象。 |
列出拥有的设备 | directoryObject collection | 从 ownedDevices 导航属性获取用户拥有的设备。 |
列出拥有的对象 | directoryObject collection | 从 ownedObjects 导航属性获取用户拥有的目录对象。 |
列出用户拥有的已删除组 | directoryObject collection | 检索过去 30 天内在租户中删除的组以及用户拥有的组。 |
列出注册的设备 | directoryObject 集合 | 从 registeredDevices 导航属性中获取为此用户注册的设备。 |
List deleted items | directoryObject collection | 检索最近 30 天内在租户中删除的用户。 |
Get deleted item | directoryObject collection | 按 ID 检索已删除的用户。 |
Restore deleted item | directoryObject collection | 还原最近 30 天内在租户中删除的用户。 |
永久删除项目 | directoryObject collection | 从租户中永久删除已删除的用户。 |
驱动器 | ||
获取驱动器 | drive | 检索 Drive 资源的属性和关系。 |
列出子项 | DriveItems | 在 DriveItem 的子项关系中返回 DriveItems 集合。 |
组 | ||
列出加入的团队 | 团队 集合 | 从 joinedTeams 导航属性中获取此用户直接所属的 Microsoft Teams 团队。 |
列出隶属于 | directoryObject 集合 | 获取用户直接所属的组、目录角色和管理单元。 此操作不可传递。 |
列出 的可传递成员 | directoryObject 集合 | 通过直接或可传递成员身份获取用户所属的组、目录角色和管理单元。 |
见解 | ||
共享的列表 | sharedInsight 集合 | 获取共享文件的列表。 |
列出趋势 | trending 集合 | 获取热门文件的列表。 |
使用的列表 | usedInsight 集合 | 获取已用文件的列表。 |
获取内容发现设置 | userSettings | 获取用户的内容发现设置。 |
更新内容发现设置 | None | 更新用户的内容发现设置。 |
许可证管理 | ||
分配许可证 | user | 为用户添加或删除订阅。 还可以启用和禁用与订阅相关的特定计划。 |
列出许可证详细信息 | licenseDetails 集合 | 获取 licenseDetails 对象集合。 |
重新处理许可证分配 | user | 重新处理用户的订阅分配。 |
邮件 | ||
列出邮件文件夹 | mailFolder 集合 | 在已登录用户的根文件夹下获取邮件文件夹集合。 |
创建邮件文件夹 | mailFolder | 通过发布到 mailFolders 集合创建新 MailFolder。 |
列出邮件 | message 集合 | 获取已登录用户的邮箱中的所有邮件。 |
创建邮件 | 邮件 | 通过发布到邮件集合新建邮件。 |
列出替代 | inferenceClassificationOverride 集合 | 获取重点收件箱替代用户配置为始终以特定方式对来自某些发件人的邮件进行分类。 |
创建替代 | inferenceClassificationOverride | 创建由 SMTP 地址识别的发件人的重点收件箱替代。 |
List rules | messageRule 集合 | 获取为用户收件箱定义的所有 messageRule 对象。 |
创建规则 | messageRule | 通过指定一组条件和操作来创建 messageRule 对象。 |
发送邮件 | 无 | 发送请求正文中指定的邮件。 |
获取邮件提示 | 邮件提醒集合 | 返回向已登录用户提供的一个或多个收件人的邮件提醒。 |
注意 | ||
列出笔记本 | notebook 集合 | 检索 notebook 对象列表。 |
创建笔记本 | 笔记本 | 新建 OneNote 笔记本。 |
组织层次结构 | ||
分配管理器 | directoryObject | 分配用户或组织联系人,作为该用户的经理。 |
获取管理器 | directoryObject | 从 manager 导航属性中获取是此用户的经理的用户或组织联系人。 |
删除管理器 | None | 删除用户的经理。 |
列出直接下属 | directoryObject collection | 从 directReports 导航属性中获取向此用户报告的用户和联系人。 |
Outlook 设置 | ||
获取用户的邮箱设置 | mailboxSettings | 获取用户的 mailboxSettings。 |
更新用户邮箱设置 | mailboxSettings | 为用户启用、配置或禁用一个或多个 mailboxSettings。 |
列出 Outlook 类别 | outlookCategory 集合 | 获取为用户定义的所有类别。 |
创建 Outlook 类别 | outlookCategory | 在用户主类别列表中创建 outlookCategory 对象。 |
获取支持的语言 | localeInfo 集合 | 获取用户支持的区域设置和语言列表,用户的邮箱服务器上配置了此信息。 |
获取支持的时区 | timeZoneInformation 集合 | 获取用户支持的时区列表,就像在用户的邮箱服务器上配置的那样。 |
翻译 Exchange ID | convertIdResult 集合 | 对与 Outlook 相关的资源的标识符进行格式转换。 |
人员 | ||
List | person 集合 | 获取按与用户的相关性排序的人员对象集合。 |
个人联系人 | ||
List contacts | 联系人集合 | 从已登录用户的默认联系人文件夹中获取联系人集合。 |
创建联系人 | 联系人 | 通过发布到联系人集合新建联系人。 |
列出联系人文件夹 | ContactFolder 集合 | 获取已登录用户的默认联系人文件夹中的联系人文件夹集合。 |
创建联系人文件夹 | contactFolder | 通过发布到 contactFolders 集合创建新 ContactFolder。 |
个人资料照片 | ||
Get | profilePhoto | 获取指定的 profilePhoto 或其元数据(profilePhoto 属性)。 |
更新 | 无 | 更新租户中任意用户的照片,其中包括已登录用户或指定的组或联系人。 |
删除 | None | 删除租户中任何用户(包括已登录用户或指定组)的照片。 |
计划表 | ||
List tasks | plannerTask 集合 | 获取分配给此用户的 plannerTasks。 |
赞助商 | ||
Assign | None | 为用户分配发起人。 |
List | directoryObject collection | 获取此用户的发起人的用户和组。 |
Remove | None | 删除用户的发起人。 |
Teamwork | ||
列出关联的团队 | associatedTeamInfo 集合 | 获取用户与之关联的 Microsoft Teams 中的团队列表。 |
列出为用户安装的应用 | userScopeTeamsAppInstallation 集合 | 列出安装在用户个人范围内的应用。 |
获取为用户安装的应用 | userScopeTeamsAppInstallation | 列出安装在用户个人范围内的指定应用。 |
为用户添加应用 | 无 | 在用户的个人范围内添加(安装)应用。 |
为用户删除应用 | 无 | 删除(卸载)用户个人范围内的应用。 |
升级为用户安装的应用 | 无 | 将安装在用户个人范围内的应用升级到最新版本。 |
获取用户和应用之间的聊天 | 聊天 | 列出用户和应用之间的一对一聊天。 |
List permission grants | resourceSpecificPermissionGrant 集合 | 列出用户授予的所有特定于资源的权限。 |
待办任务 | ||
列出任务 | todoTask 集合 | 获取指定列表中的所有 todoTask 资源。 |
创建任务 | todoTask | 在指定的任务列表中创建 todoTask。 |
列出任务列表 | todoTaskList 集合 | 获取用户邮箱中的所有任务列表。 |
创建任务列表 | todoTaskList | 在用户的邮箱中创建微软待办任务列表。 |
用户设置 | ||
Get | userSettings | 阅读用户和组织设置对象。 |
更新 | userSettings | 更新 settings 对象的属性。 |
属性
重要
仅当使用设置为 eventual
和 $count
的 ConsistencyLevel 标头时,才支持 $filter
和 $search
查询参数的特定用法。 有关详细信息,请参阅 目录对象的高级查询功能。
属性 | 类型 | 说明 |
---|---|---|
aboutMe | String | 任意形式的文本输入字段,用于介绍用户自身。 仅在 $select 上返回。 |
accountEnabled | Boolean | 启用帐户时为 true ,否则为 false 。 创建用户时此属性是必需的。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 和 in )。 |
ageGroup | ageGroup | 设置用户的年龄组。 允许的值: null 、 Minor 、 NotAdult 和 Adult 。 有关详细信息,请参阅 法定年龄组属性定义。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 和 in )。 |
assignedLicenses | assignedLicense collection | 已分配给用户的许可证,包括继承的(基于组的)许可证。 此属性不区分直接分配的许可证和继承的许可证。 使用 licenseAssignmentStates 属性标识直接分配的许可证和继承的许可证。 不可为 null。 仅在 $select 上返回。 支持 $filter (eq 、 not 、 /$count eq 0 、 /$count ne 0 )。 |
assignedPlans | assignedPlan collection | 分配给该用户的计划。 只读。 不可为 null。 仅在 $select 上返回。 支持 $filter (eq 和 not )。 |
birthday | DateTimeOffset | 用户的生日。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z 。 仅在 $select 上返回。 |
businessPhones | String collection | 用户的电话号码。 注意:虽然它是字符串集合,但只能为此属性设置一个数字。 从本地目录同步的用户为只读。 默认情况下返回。 支持 $filter (eq 、not 、ge 、le 、startsWith )。 |
城市 | String | 用户所在的城市。 最大长度为 128 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
CompanyName | String | 与用户关联的公司的名称。 此属性可用于描述来宾来自的公司。 最大长度为 64 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
consentProvidedForMinor | consentProvidedForMinor | 设置是否获得未成年人的同意。 允许的值: null 、 Granted 、 Denied 和 NotRequired 。 有关详细信息,请参阅 法定年龄组属性定义。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 和 in )。 |
country | String | 用户所在的国家/地区;例如, US 或 UK 。 最大长度为 128 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
createdDateTime | DateTimeOffset | 创建用户的日期和时间,采用 ISO 8601 格式和 UTC 格式。 无法修改值,并在创建实体时自动填充。 可为 Null。 对于本地用户,值表示首次在 Microsoft Entra ID 中创建用户。 属性适用于null 在 2018 年 6 月之前创建的一些用户,以及 2018 年 6 月之前同步到 Microsoft Entra ID 的本地用户。 只读。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in )。 |
creationType | 字符串 | 指示是否通过以下方法之一创建用户帐户:
只读。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 in )。 |
customSecurityAttributes | customSecurityAttributeValue | 保留分配给目录对象的自定义安全属性的值的开放式复杂类型。 可为 NULL。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 startsWith )。 筛选器值区分大小写。 |
deletedDateTime | DateTimeOffset | 删除用户的日期和时间。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in )。 |
department | String | 用户所在的部门的名称。 最大长度为 64 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 和 null 值上的 eq )。 |
displayName | String | 用户通讯簿中显示的名称。 此值通常是用户名字、中间首字母和姓氏的组合。 创建用户时,此属性是必需的,在更新期间无法清除该属性。 最大长度为 256 个字符。 默认情况下返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )、$orderby 和 $search 。 |
employeeHireDate | DateTimeOffset | 用户被雇用或将在将来的雇用中开始工作的日期和时间。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in )。 |
employeeLeaveDateTime | DateTimeOffset | 用户离开或将离开组织的日期和时间。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in )。 有关详细信息,请参阅 为用户配置 employeeLeaveDateTime 属性。 |
employeeId | String | 由组织分配给该用户的员工标识符。 最大长度为 16 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
employeeOrgData | employeeOrgData | 表示组织数据 (例如,与用户关联的部门和 costCenter) 。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in )。 |
employeeType | String | 捕获企业员工类型。 例如,Employee 、Contractor 、Consultant 或 Vendor 。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in 、 startsWith )。 |
externalUserState | String | 对于使用邀请 API 邀请到租户的来宾,此属性表示受邀用户的邀请状态。 对于受邀用户,状态可以是 PendingAcceptance 或 Accepted ,而对于所有其他用户,状态为 null 。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 in )。 |
externalUserStateChangeDateTime | DateTimeOffset | 显示最近一次修改 externalUserState 属性的时间戳。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 in )。 |
faxNumber | String | 用户的传真号。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
givenName | String | 用户的名。 最大长度为 64 个字符。 默认情况下返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
hireDate | DateTimeOffset | 用户的雇佣日期。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z 。 仅在 $select 上返回。 注意: 此属性特定于 Microsoft 365 中的 SharePoint。 建议使用本地 employeeHireDate 属性来设置和更新使用 Microsoft Graph API 的聘用日期值。 |
id | String | 用户的唯一标识符。 应视为不透明的标识符。 继承自 directoryObject。 键。 不可为 null。 只读。 默认情况下返回。 支持 $filter (eq 、 ne 、 not 、 in )。 |
identities | objectIdentity 集合 | 表示可用于登录此用户帐户的标识。 Microsoft (也称为本地帐户,) 、组织或社交标识提供者(如 Facebook、Google 和 Microsoft)可以提供标识并将其绑定到用户帐户。 它可能包含具有相同 signInType 值的多个项。 仅在 $select 上返回。 支持 $filter 有限制的 eq () 。 |
imAddresses | String collection | 即时消息语音 IP (VOIP) 会话启动协议 (用户的 SIP) 地址。 只读。 仅在 $select 上返回。 支持 $filter (eq 、 not 、 ge 、 le 、 startsWith )。 |
interests | String collection | 用户介绍自身兴趣的列表。 仅在 $select 上返回。 |
isResourceAccount | Boolean | 请勿使用 - 保留供将来使用。 |
jobTitle | String | 用户的职务。 最大长度为 128 个字符。 默认情况下返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
lastPasswordChangeDateTime | DateTimeOffset | 此Microsoft Entra用户上次更改其密码的时间或创建其密码的时间,以执行最新操作的日期为准。 日期和时间信息使用 ISO 8601 格式,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z 。 仅在 $select 上返回。 |
legalAgeGroupClassification | legalAgeGroupClassification | 由企业应用程序用于确定用户的法定年龄组。 此属性为只读,并且基于 ageGroup 和 consentProvidedForMinor 属性进行计算。 允许的值:null 、、MinorWithOutParentalConsent 、MinorWithParentalConsent MinorNoParentalConsentRequired 、NotAdult 、 和 Adult 。 有关详细信息,请参阅 法定年龄组属性定义。 仅在 $select 上返回。 |
licenseAssignmentStates | licenseAssignmentState 集合 | 此用户的许可证分配状态。 还指示直接分配的许可证或用户通过组成员身份继承的许可证。 只读。 仅在 $select 上返回。 |
String | 用户的 SMTP 地址,例如, jeff@contoso.com 。 对此属性的更改将更新用户的 proxyAddresses 集合,以将值作为 SMTP 地址包含在内。 此属性不能包含重音字符。 注意: 建议不要为 Azure AD B2C 用户配置文件更新此属性。 请改用 otherMails 属性。 默认情况下返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 、endsWith 和 null 值上的 eq )。 |
|
mailboxSettings | mailboxSettings | 已登录用户的主邮箱的设置。 可以获取或更新用于向传入邮件发送自动答复、区域设置和时区的设置。 仅在 $select 上返回。 |
mailNickname | String | 用户的邮件别名。 创建用户时必须指定此属性。 最大长度为 64 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
mobilePhone | String | 用户的主要移动电话号码。 从本地目录同步的用户为只读。 最大长度为 64 个字符。 默认情况下返回。 支持 $filter ) ge le not ne startsWith eq in 和 eq 的值上 null (、 和 。$search |
mySite | String | 用户网站的 URL。 仅在 $select 上返回。 |
officeLocation | String | 用户公司地点的办公室位置。 默认返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
onPremisesDistinguishedName | String | 包含本地 Active Directory distinguished name 或 DN 。 仅为通过 Microsoft Entra Connect 将本地目录同步到Microsoft Entra ID的客户填充属性。 只读。 仅在 $select 上返回。 |
onPremisesDomainName | String | 包含从本地目录同步的本地 domainFQDN (也称为 dnsDomainName)。 仅为通过 Microsoft Entra Connect 将本地目录同步到Microsoft Entra ID的客户填充属性。 只读。 仅在 $select 上返回。 |
onPremisesExtensionAttributes | onPremisesExtensionAttributes | 包含用户的 extensionAttributes1-15。 这些扩展属性也称 Exchange 自定义属性 1-15。 每个属性最多可以存储 1024 个字符。 false 的仅限云用户 (,可以在创建或更新用户对象期间设置这些属性。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 in )。 |
onPremisesImmutableId | String | 此属性用于将本地 Active Directory用户帐户与其Microsoft Entra用户对象相关联。 如果将联合域用于用户的 userPrincipalName (UPN) 属性,则必须在 Graph 中创建新用户帐户时指定此属性。
注意: 指定 $ 此属性时,不能使用 和 _ 字符。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in )。 |
onPremisesLastSyncDateTime | DateTimeOffset | 表示上一次对象与本地目录同步的时间;例如:2013-02-16T03:04:54Z 。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z 。 只读。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in )。 |
onPremisesProvisioningErrors | onPremisesProvisioningError 集合 | 在预配期间使用 Microsoft 同步产品时发生的错误。 仅在 $select 上返回。 支持 $filter (eq 、 not 、 ge 、 le )。 |
onPremisesSamAccountName | String | 包含从本地目录同步的本地 samAccountName 。 仅为通过 Microsoft Entra Connect 将本地目录同步到Microsoft Entra ID的客户填充属性。 只读。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in 、 startsWith )。 |
onPremisesSecurityIdentifier | String | 包含从本地同步到云的用户的本地安全标识符 (SID)。 只读。 仅在 $select 上返回。 支持 $filter (eq 包括在 null 值上)。 |
onPremisesSyncEnabled | Boolean |
true 如果当前正在从本地 Active Directory (AD) 同步此用户对象,则为 ;否则不会同步该用户,并且可以在 Microsoft Entra ID 中管理。 只读。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、in 和 null 值上的 eq )。 |
onPremisesUserPrincipalName | String | 包含从本地目录同步的本地 userPrincipalName 。 仅为通过 Microsoft Entra Connect 将本地目录同步到Microsoft Entra ID的客户填充属性。 只读。 仅在 $select 上返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in 、 startsWith )。 |
otherMails | 字符串集合 | 用户的其他电子邮件地址列表;例如: ["bob@contoso.com", "Robert@fabrikam.com"] 。 注意:此属性不能包含重音字符。 仅在 $select 上返回。 支持 (、、、 in /$count eq 0 startsWith /$count ne 0 endsWith le ge ) 。 not eq $filter |
passwordPolicies | String | 指定用户的密码策略。 此值表示枚举,其中一个可能 DisableStrongPassword 为枚举值,允许指定超过默认策略的密码。
DisablePasswordExpiration 也可以指定 。 两者可以一起指定:例如: DisablePasswordExpiration, DisableStrongPassword 。 仅在 $select 上返回。 有关默认密码策略的详细信息,请参阅Microsoft Entra密码策略。 支持 $filter (ne 、not 和 null 值上的 eq )。 |
passwordProfile | passwordProfile | 指定用户的密码配置文件。 配置文件包含用户的密码。 创建用户时此属性是必需的。 配置文件中的密码必须满足 passwordPolicies 属性指定的最低要求。 默认情况下,必须使用强密码。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、in 和 null 值上的 eq )。 若要更新此属性,请: |
pastProjects | String collection | 供用户枚举其过去项目的列表。 仅在 $select 上返回。 |
postalCode | String | 用户邮政地址的邮政编码。 邮政编码特定于用户所在的国家/地区。 在美国,此属性包含邮政编码。 最大长度为 40 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
preferredDataLocation | String | 用户的首选数据位置。 有关详细信息,请参阅 OneDrive Online 多地理位置。 |
preferredLanguage | String | 用户的首选语言。 首选语言格式基于 RFC 4646。 该名称是与语言关联的 ISO 639 双字母小写区域性代码和与国家或地区关联的 ISO 3166 双字母大写子区域性代码的组合。 示例:“en-US”或“es-ES”。 默认情况下返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq ) |
preferredName | String | 用户的首选名称。 不支持。 此属性返回空字符串。 仅在 $select 上返回。 |
provisionedPlans | provisionedPlan 集合 | 为用户设置的计划。 只读。 不可为 null。 仅在 $select 上返回。 支持 $filter (eq 、 not 、 ge 、 le )。 |
proxyAddresses | String collection | 例如:["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"] 。 对 mail 属性的更改会更新此集合,以将值作为 SMTP 地址包含在内。 有关详细信息,请参阅 mail 和 proxyAddresses 属性。 以 SMTP (大写) 作为前缀的代理地址是主要代理地址,而以 作为前缀的 smtp 地址是辅助代理地址。 对于 Azure AD B2C 帐户,此属性限制为 10 个唯一地址。 Microsoft Graph 中的只读;只能通过 Microsoft 365 管理中心 来更新此属性。 不可为 null。 仅在 $select 上返回。 支持 $filter (eq 、 not 、 ge 、 le 、 startsWith 、 endsWith 、 /$count eq 0 、 /$count ne 0 )。 |
refreshTokensValidFromDateTime | DateTimeOffset | 在此时间之前) 颁发的任何刷新令牌或会话令牌 (会话 Cookie 都是无效的。 使用无效的刷新令牌或会话令牌获取委派访问令牌时,应用程序会收到错误, (访问 api(如 Microsoft Graph) )。 如果发生这种情况,应用程序需要通过请求授权的终结点来获取新的刷新令牌。 仅在 $select 上返回。 只读。 |
responsibilities | String collection | 供用户枚举其职责的列表。 仅在 $select 上返回。 |
serviceProvisioningErrors | serviceProvisioningError 集合 | 联合服务发布的错误,描述与用户对象中的属性或链接相关的非特定于服务的错误。 对于 isResolved 和 serviceInstance) eq not ,支持 $filter (、、 。 |
schools | String collection | 供用户枚举他们就读的学校的列表。 仅在 $select 上返回。 |
securityIdentifier | 字符串 | 用户的安全标识符 (SID),用于 Windows 应用场景。 只读。 默认情况下返回。 支持 $select 和 $filter (eq 、not 、ge 、le 、startsWith )。 |
showInAddressList | Boolean | 请勿在 Microsoft Graph 中使用。 请改为通过Microsoft 365 管理中心管理此属性。 表示是否应将用户包含在 Outlook 全局地址列表中。 请参阅 已知问题。 |
signInActivity | signInActivity | 获取指定用户登录的最后一个登录日期和请求 ID。 只读。 仅在 $select 上返回。 支持 $filter (eq 、ne 、、not ge ) le 但不支持任何其他可筛选属性。 注意: |
signInSessionsValidFromDateTime | DateTimeOffset | 在此时间之前) 颁发的任何刷新令牌或会话令牌 (会话 Cookie 都是无效的。 使用无效的刷新令牌或会话令牌获取委派访问令牌时,应用程序会收到错误, (访问 api(如 Microsoft Graph) )。 如果发生这种情况,应用程序需要通过请求授权的终结点来获取新的刷新令牌。 只读。 使用 revokeSignInSessions 进行重置。 仅在 $select 上返回。 |
skills | String collection | 供用户枚举其技能的列表。 仅在 $select 上返回。 |
state | String | 用户地址中的省/市/自治区或省。 最大长度为 128 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
streetAddress | String | 用户公司地点的街道地址。 最大长度为 1,024 个字符。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
surname | String | 用户的姓氏。 最大长度为 64 个字符。 默认返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
usageLocation | String | 两个字母组成的国家/地区代码(ISO 标准 3166)。 对于由于法律要求而分配许可证的用户需要检查国家/地区的服务可用性。 示例包括: US 、 JP 和 GB 。 不可为 null。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、ge 、le 、in 、startsWith 和 null 值上的 eq )。 |
userPrincipalName | String | 用户的用户主体名称 (UPN)。 UPN 是基于 Internet 标准 RFC 822 的用户的 Internet 样式登录名称。 根据约定,此值应映射到用户的电子邮件名称。 常规格式为alias@domain,其中域必须存在于租户的已验证域集合中。 创建用户时此属性是必需的。 可从 组织 的 verifiedDomains 属性访问租户的已验证域。 注意:此属性不能包含重音字符。 仅支持使用以下字符: A - Z 、a - z 、0 - 9 、 ' . - _ ! # ^ ~ 。 有关允许字符的完整列表,请参阅用户名策略。 默认情况下返回。 支持 $filter (eq 、 ne 、 not 、 ge 、 le 、 in 、 startsWith 、 endsWith ) 和 $orderby 。 |
userType | String | 可用于对目录中的用户类型进行分类的字符串值。 可能的值为 Member 和 Guest 。 仅在 $select 上返回。 支持 $filter (eq 、ne 、not 、in 和 null 值上的 eq )。
注意:有关成员和来宾的权限的详细信息,请参阅 Microsoft Entra ID 中的默认用户权限是什么? |
提示
目录和架构扩展及其关联数据仅在 $select
上返回;开放扩展及其关联的数据仅在 $expand
上返回。
mail 和 proxyAddresses 属性
mail 和 proxyAddresses 都是与电子邮件相关的属性。 proxyAddresses 属性是仅与 Microsoft Exchange 服务器相关的地址的集合。 它用于存储绑定到单个邮箱的用户的邮件地址列表。 邮件属性用作用户的电子邮件地址,用于各种目的(包括用户登录),并定义主代理地址。
可以通过 GET 用户 API 检索 mail 和 proxyAddresses。 可以通过更新用户 API 更新邮件,但无法通过 Microsoft Graph 更新 proxyAddresses。 更新用户的 mail 属性时,将触发重新计算 proxyAddresses,并将新更新的邮件设置为主要代理地址,但在以下方案中除外:
- 如果用户具有包含 Microsoft Exchange 的许可证,则其所有代理地址必须属于租户上的已验证域。 任何不属于已验证域的域都将以无提示方式删除。
- 如果用户是来宾,并且主代理地址包含来宾的 UPN 字符串,则不会将用户的邮件设置为主代理地址 #EXT#。
- 如果用户是来宾,即使用户不再具有代理地址,也不会删除用户的邮件。
proxyAddresses 在目录对象(用户、组和组织联系人)中是唯一的。 如果用户 的邮件 属性与另一个对象的 一个 proxyAddresses 冲突,则更新 邮件 的尝试会失败,并且 proxyAddresses 属性也不会更新。
法定年龄组属性定义
本部分介绍 (Microsoft Entra管理员和企业应用程序开发人员如何使用 legalAgeGroupClassification、ageGroup 和 consentProvidedForMinor) 这三个年龄组属性来满足与年龄相关的法规:
- legalAgeGroupClassification 属性为只读属性。 企业应用程序开发人员使用它来确保根据用户法定年龄组正确处理用户。 它根据用户的 ageGroup 和 consentProvidedForMinor 属性进行计算。
- ageGroup 和 consentProvidedForMinor 是Microsoft Entra管理员使用的可选属性,可帮助确保根据管理用户国家或地区的年龄相关法规规则正确处理帐户的使用。
例如:Cameron 是英国霍利波特小学目录的管理员。 在学年开始时,他根据联合王国与年龄有关的规定,利用招生文件获得未成年人父母的同意。 从家长获得的同意允许霍利波特学校和Microsoft应用程序使用未成年人的帐户。 Cameron 随后创建所有帐户,将 ageGroup 设置为 minor
,consentProvidedForMinor 设置为 granted
。 然后,他的学生使用的应用程序能够抑制不适合未成年人的功能。
legalAgeGroupClassification values
成员 | 说明 |
---|---|
空 | 默认值,不为用户设置 ageGroup 。 |
MinorWithoutParentalConsent | (保留以备今后使用) |
MinorWithParentalConsent | 根据其国家或地区的年龄相关规定,用户被视为未成年人,并且帐户管理员已获得家长或监护人的相应同意。 |
Adult | 根据所在国家或地区的年龄相关法规,用户被视为成年人。 |
NotAdult | 用户来自具有其他年龄相关法规(如美国、英国、欧盟或韩国)的国家或地区,并且用户的年龄介于未成年人和成人年龄之间, (根据国家或地区) 的规定。 通常,这意味着会在管控的国家或地区将青少年视为 notAdult 。 |
MinorNoParentalConsentRequired | 用户是未成年人,但所在国家或地区没有与年龄相关的法规。 |
ageGroup 值
成员 | 说明 |
---|---|
空 | 默认值,不为用户设置 ageGroup 。 |
次要 | 该用户被视为未成年人。 |
NotAdult | 用户来自美国、英国、欧盟或韩国等具有法定法规的国家/地区,并且用户的年龄超过国家/地区) 儿童年龄 (上限,并且小于根据国家或地区) 规定的成人年龄 (下限。 因此,基本上会在管控的国家或地区将青少年视为 notAdult 。 |
Adult | 用户应被视为成年人。 |
consentProvidedForMinor 值
成员 | 说明 |
---|---|
空 | 默认值,不为用户设置 consentProvidedForMinor 。 |
Granted | 获取用户拥有帐户的同意。 |
Denied | 不会获得用户拥有帐户的同意。 |
NotRequired | 用户来自不需要同意的位置。 |
关系
关系 | 类型 | 说明 |
---|---|---|
activities | userActivity 集合 | 跨设备的用户活动。 只读。 可为 Null。 |
agreementAcceptances | agreementAcceptance 集合 | 用户使用条款接受状态。 只读。 可为 NULL。 |
appRoleAssignments | appRoleAssignment 集合 | 表示用户为应用程序授予的应用角色。 支持 $expand 。 |
身份验证 | 身份验证 | 用户支持的身份验证方法。 |
日历 | calendar | 用户的主日历。 只读。 |
calendarGroups | CalendarGroup 集合 | 用户的日历组。 只读。 可为 Null。 |
calendars | calendar 集合 | 用户的日历。 只读。 可为 Null。 |
calendarView | event 集合 | 日历的日历视图。 只读。 可为 Null。 |
contactFolders | ContactFolder 集合 | 用户的联系人文件夹。 只读。 可为 Null。 |
contacts | contact 集合 | 用户的联系人。 只读。 可为 Null。 |
createdObjects | directoryObject collection | 用户创建的目录对象。 此为只读属性。 可为 Null。 |
directReports | directoryObject collection | 向该用户报告的用户和联系人。 (将其经理属性设置为此用户的用户和联系人。)只读。 可为空。 支持 $expand 。 |
驱动器 | drive | 用户的 OneDrive。 只读。 |
drives | drive 集合 | 此用户可用的驱动器集合。 只读。 |
events | event 集合 | 用户的事件。 默认显示“默认日历”下的事件。 只读。 可为 NULL。 |
extensions | 扩展集合 | 为用户定义的开放扩展集合。 只读。 支持 $expand 。 可为 Null。 |
inferenceClassification | inferenceClassification | 基于替代推断的相关性或重要性的显式指定对用户消息进行相关性分类。 |
insights | itemInsights | 表示用户与工作或学校文档的 OneDrive 等项之间的关系,这些文档使用高级分析和机器学习技术进行计算。 只读。 可为 Null。 |
licenseDetails | licenseDetails 集合 | 此用户许可证详细信息的集合。 只读。 |
mailFolders | mailFolder 集合 | 用户的邮件文件夹。 只读。 可为 Null。 |
manager | directoryObject | 是此用户的经理的用户或联系人。 只读。 支持 $expand 。 |
memberOf | directoryObject collection | 用户所属的组和目录角色。 只读。 可为 NULL。 支持 $expand 。 |
messages | message 集合 | 邮箱或文件夹中的邮件。 只读。 可为 Null。 |
onenote | onenote | 只读。 |
onlineMeetings | onlineMeeting 集合 | 有关会议的信息,包括用于加入会议的 URL、与会者列表和说明。 |
outlook | outlookUser | 只读。 |
ownedDevices | directoryObject collection | 用户拥有的设备。 此为只读属性。 可为 Null。 支持 $expand 和 $filter (/$count eq 0 、 /$count ne 0 、 /$count eq 1 ) /$count ne 1 。 |
ownedObjects | directoryObject collection | 用户拥有的目录对象。 此为只读属性。 可为 Null。 支持 $expand 、$select 嵌套在 和 $expand $filter (/$count eq 0 、/$count ne 0 、 /$count eq 1 /$count ne 1 ) 。 |
people | person 集合 | 与用户相关的人员。 只读。 可为 NULL。 |
permissionGrants | resourceSpecificPermissionGrant 集合 | 列出用户授予的所有特定于资源的权限。 |
photo | profilePhoto | 用户的个人资料照片。 只读。 |
photos | profilePhoto 集合 | 不同大小的用户配置文件的集合。 此为只读属性。 |
planner | plannerUser | 用户可能存在的 Planner 资源入口点。 只读。 |
registeredDevices | directoryObject collection | 已注册的用户的设备。 只读。 可为 Null。 支持 $expand 并返回最多 100 个对象。 |
解决 方案 | userSolutionRoot | 将用户与工作时间计划触发器关联的标识符。 只读。 可为空 |
赞助商 | directoryObject collection | 负责此来宾在租户中的特权的用户和组,并更新来宾的信息和访问权限。 (HTTP 方法:GET、POST、DELETE.) 。 支持 $expand 。 |
团队合作 | userTeamwork | 可供用户使用的 Microsoft Teams 功能的容器。 只读。 可为 Null。 |
todo | todo | 表示用户可以使用的微软待办服务。 |
transitiveMemberOf | directoryObject 集合 | 用户所属的组(包括嵌套组)和目录角色。 可为 Null。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"aboutMe": "String",
"accountEnabled": true,
"ageGroup": "String",
"assignedLicenses": [{"@odata.type": "microsoft.graph.assignedLicense"}],
"assignedPlans": [{"@odata.type": "microsoft.graph.assignedPlan"}],
"birthday": "String (timestamp)",
"businessPhones": ["String"],
"city": "String",
"companyName": "String",
"consentProvidedForMinor": "String",
"country": "String",
"createdDateTime": "String (timestamp)",
"creationType": "String",
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"department": "String",
"displayName": "String",
"employeeHireDate": "2020-01-01T00:00:00Z",
"employeeId": "String",
"employeeOrgData": {"@odata.type": "microsoft.graph.employeeOrgData"},
"employeeType": "String",
"faxNumber" : "String",
"givenName": "String",
"hireDate": "String (timestamp)",
"id": "String (identifier)",
"identities": [{"@odata.type": "microsoft.graph.objectIdentity"}],
"imAddresses": ["String"],
"interests": ["String"],
"isResourceAccount": false,
"jobTitle": "String",
"legalAgeGroupClassification": "String",
"licenseAssignmentStates": [{"@odata.type": "microsoft.graph.licenseAssignmentState"}],
"lastPasswordChangeDateTime": "String (timestamp)",
"mail": "String",
"mailboxSettings": {"@odata.type": "microsoft.graph.mailboxSettings"},
"mailNickname": "String",
"mobilePhone": "String",
"mySite": "String",
"officeLocation": "String",
"onPremisesDistinguishedName": "String",
"onPremisesDomainName": "String",
"onPremisesExtensionAttributes": {"@odata.type": "microsoft.graph.onPremisesExtensionAttributes"},
"onPremisesImmutableId": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesProvisioningErrors": [{"@odata.type": "microsoft.graph.onPremisesProvisioningError"}],
"onPremisesSamAccountName": "String",
"onPremisesSecurityIdentifier": "String",
"onPremisesSyncEnabled": true,
"onPremisesUserPrincipalName": "String",
"otherMails": ["String"],
"passwordPolicies": "String",
"passwordProfile": {"@odata.type": "microsoft.graph.passwordProfile"},
"pastProjects": ["String"],
"postalCode": "String",
"preferredDataLocation": "String",
"preferredLanguage": "String",
"preferredName": "String",
"provisionedPlans": [{"@odata.type": "microsoft.graph.provisionedPlan"}],
"proxyAddresses": ["String"],
"responsibilities": ["String"],
"schools": ["String"],
"securityIdentifier": "String",
"serviceProvisioningErrors": [
{ "@odata.type": "microsoft.graph.serviceProvisioningXmlError" }
],
"showInAddressList": true,
"signInActivity": {"@odata.type": "microsoft.graph.signInActivity"},
"signInSessionsValidFromDateTime": "String (timestamp)",
"skills": ["String"],
"state": "String",
"streetAddress": "String",
"surname": "String",
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String",
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"calendarGroups": [{ "@odata.type": "microsoft.graph.calendarGroup" }],
"calendarView": [{ "@odata.type": "microsoft.graph.event" }],
"calendars": [ {"@odata.type": "microsoft.graph.calendar"} ],
"contacts": [ { "@odata.type": "microsoft.graph.contact" } ],
"contactFolders": [ { "@odata.type": "microsoft.graph.contactFolder" } ],
"createdObjects": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
"directReports": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
"drive": { "@odata.type": "microsoft.graph.drive" },
"drives": [ { "@odata.type": "microsoft.graph.drive" } ],
"events": [ { "@odata.type": "microsoft.graph.event" } ],
"inferenceClassification": { "@odata.type": "microsoft.graph.inferenceClassification" },
"mailFolders": [ { "@odata.type": "microsoft.graph.mailFolder" } ],
"manager": { "@odata.type": "microsoft.graph.directoryObject" },
"memberOf": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
"messages": [ { "@odata.type": "microsoft.graph.message" } ],
"outlook": { "@odata.type": "microsoft.graph.outlookUser" },
"ownedDevices": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
"ownedObjects": [ { "@odata.type": "microsoft.graph.directoryObject" } ],
"photo": { "@odata.type": "microsoft.graph.profilePhoto" },
"photos": [ { "@odata.type": "microsoft.graph.profilePhoto" } ],
"registeredDevices": [ { "@odata.type": "microsoft.graph.directoryObject" } ]
}