用户资源类型

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

表示Microsoft Entra用户帐户。 此资源是允许传入其他属性的开放类型。 继承自 directoryObject

用户资源允许应用为用户的主要 Exchange 邮箱和Microsoft Entra配置文件指定语言的用户首选项和日期/时间格式。 有关详细信息,请参阅 语言和区域格式的用户首选项

出于性能原因,默认情况下 creategetlist 操作仅返回更常用属性的子集。 这些默认属性将记录在属性部分中。 若要获取默认情况下不返回的任何属性,请在 OData 查询选项中 $select 指定它们。

该资源支持:

方法

方法 返回类型 Description
List user 集合 获取用户对象列表。
创建 user 新建用户对象。
Get user 读取 user 对象的属性和关系。
更新 user 更新 user 对象。
删除 None 删除 user 对象。
获取增量 user 集合 获取用户的增量更改。
更改密码 更新自己的密码。
验证密码 passwordValidationInformation 根据组织的密码验证策略验证用户的密码,并报告密码是否有效。
重试服务预配 None 重试用户服务预配。
将外部用户转换为内部成员用户 user 将经过外部身份验证的用户转换为内部成员用户。
使所有刷新令牌无效 用户 使发给应用程序的所有用户刷新令牌无效。 请勿使用。 改用 user:revokeSignInSessions 方法。
撤销登录会话 None 通过将 signInSessionsValidFromDateTime 用户属性重置为当前日期时间,撤销向应用程序颁发的所有用户刷新和会话令牌。 此操作将强制用户再次登录到这些应用程序。 此方法将替换 invalidateAllRefreshTokens
导出个人数据 None 提交公司管理员提出的数据策略操作请求,以导出组织用户的数据。
AI 交互
获取所有企业交互 aiInteraction 集合 获取所有智能 Microsoft 365 Copilot 副驾驶®交互数据,包括用户提示 Copilot 和 Copilot 响应。
应用角色分配
List appRoleAssignment 集合 获取已分配用户的应用和应用角色。
添加 appRoleAssignment 向用户分配应用角色。
Remove None 从用户中删除应用角色分配。
列出 appRoleAssignedResources servicePrincipal 集合 直接或通过组成员身份获取用户具有应用角色分配的应用。
Calendar
List calendars Calendar collection 获取 Calendar 对象集合。
Create calendar Calendar 通过发布到日历集合创建新日历。
列出日历组 CalendarGroup collection 获取 CalendarGroup 对象集合。
创建日历组 CalendarGroup 通过发布到 calendarGroups 集合新建 CalendarGroup。
List events event 集合 获取用户邮箱中的 event 对象列表。 该列表包含单个实例会议和系列主控形状。
Create event event 通过发布到事件集合新建事件。
查找会议时间 meetingTimeSuggestionsResult 基于与会者忙闲状态、位置或时间限制查找会议时间和位置。
查找会议室 emailaddress.md 集合 获取用户租户或特定会议室列表中的所有会议室。
查找会议室列表 emailaddress.md 集合 获取租户中定义的会议室列表。
获取忙/闲日程安排 scheduleInformation 获取指定时间段内) 的用户、通讯组列表或资源集合 (会议室或设备的忙/闲可用性信息。
列出日历视图 event 集合 获取 event 对象集合。
提醒视图 Reminder collection 返回指定开始时间和结束时间范围内的日历提醒列表。
云许可
列表使用权限 microsoft.graph.cloudLicensing.usageRight 集合 获取授予用户的 usageRight 对象的列表。
正确使用 microsoft.graph.cloudLicensing.usageRight 获取授予用户的 usageRight 对象的属性和关系。
云电脑
列出云电脑 cloudPC 集合 列出归属于已登录用户的 cloudPC 设备。
获取启动信息 cloudPCLaunchInfo 获取已登录用户的 cloudPCLaunchInfo
委派权限授予
列出委托的权限授予 oAuth2PermissionGrant 集合 检索授予的委托权限列表,使客户端应用程序能够代表用户访问 API。
目录对象
按 ID 获取 字符串集合 返回 ID 列表中指定的目录对象。
获取目录对象的增量 directoryObject collection 获取目录对象(例如用户应用程序和服务主体)的增量更改。 需要对派生类型的 ID 或派生类型本身进行筛选。 有关增量查询的详细信息,请参阅 使用增量查询跟踪 Microsoft Graph 数据中的更改
检查成员组 String collection 检查组列表中的成员身份。 检查是可传递的。
获取成员组 字符串集合 返回用户所属的所有组。 检查是可传递的。
检查成员对象 String 集合 检查组、目录角色或管理单元对象列表中的成员身份。 检查是可传递的。
获取成员对象 字符串集合 返回用户所属的所有组、目录角色和管理单元。 检查是可传递的。
获取可传递报表 整数 从 transitiveReports 导航属性获取用户的可传递报表计数。
列出创建的对象 directoryObject collection 从 createdObjects 导航属性中获取此用户创建的目录对象。
列出拥有的设备 directoryObject collection 从 ownedDevices 导航属性获取用户拥有的设备。
列出拥有的对象 directoryObject collection 从 ownedObjects 导航属性获取用户拥有的目录对象。
列出用户拥有的已删除组 directoryObject collection 检索过去 30 天内在租户中删除的组以及用户拥有的组。
列出注册的设备 directoryObject 集合 从 registeredDevices 导航属性中获取为此用户注册的设备。
List scoped-role memberships scopedRoleMembership 集合 获取此用户的作用域角色管理单元成员身份。
列表使用权限 usageRight 集合 获取已授予用户的使用权限集合。
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 集合 计算得出的见解,可返回用户使用的文件列表。
许可证管理
分配许可证 user 为用户添加或删除订阅。 还可以启用和禁用与订阅相关的特定计划。
列出许可证详细信息 licenseDetails 集合 获取 licenseDetails 对象集合。
重新处理许可证分配 user 重新处理用户的订阅分配。
邮件
列出邮件文件夹 mailFolder 集合 在已登录用户的根文件夹下获取邮件文件夹集合。
创建邮件文件夹 mailFolder 通过发布到 mailFolders 集合创建新 mailFolder
列出邮件 message 集合 获取已登录用户的邮箱中的所有邮件。
创建邮件 message 通过发布到邮件集合创建邮件。
列出替代 inferenceClassificationOverride 集合 获取用户设置为以特定方式对来自某些发件人的邮件进行分类的重点收件箱替代。
创建替代 inferenceClassificationOverride 创建由 SMTP 地址识别的发件人的重点收件箱替代。
List rules messageRule 集合 获取为用户收件箱定义的所有 messageRule 对象。
创建规则 messageRule 通过指定一组条件和操作来创建 messageRule 对象。
发送邮件 发送请求正文中指定的邮件。
获取邮件提示 邮件提醒集合 返回向已登录用户提供的一个或多个收件人的邮件提醒。
注意
列出笔记本 notebook 集合 检索 notebook 对象列表。
创建笔记本 笔记本 新建 OneNote 笔记本。
组织层次结构
分配经理 分配用户的经理。
获取经理 directoryObject 从 manager 导航属性中获取是此用户的经理的用户或联系人。
删除管理器 None 删除用户的经理。
列出直接下属 directoryObject collection 从 directReports 导航属性中获取向此用户报告的用户和联系人。
Outlook 设置
获取用户的邮箱设置 mailboxSettings 获取用户的 mailboxSettings。
更新用户邮箱设置 mailboxSettings 为用户启用、配置或禁用一个或多个 mailboxSettings。
列出 Outlook 类别 outlookCategory 集合 获取为用户定义的所有类别。
创建 Outlook 类别 outlookCategory 在用户主类别列表中创建 outlookCategory 对象。
获取支持的语言 localeInfo 集合 获取用户支持的区域设置和语言列表,用户的邮箱服务器上配置了此信息。
获取支持的时区 timeZoneInformation 集合 获取用户支持的时区列表,就像在用户的邮箱服务器上配置的那样。
翻译 Exchange ID convertIdResult 集合 对与 Outlook 相关的资源的标识符进行格式转换。
基于密码的单一登录凭据
Get passwordSingleSignOnCredentialSet 集合 获取给定用户的基于密码的单一登录凭据列表。 从不返回密码,而是始终以 null 或空字符串的形式返回。
删除 None 删除与给定用户关联的给定服务主体的基于密码的单一登录凭据。
人员
List person 检索 person 对象列表,这些对象按与 user 的相关程度进行排序,相关程度由用户的通信和协作模式以及业务关系决定。
个人联系人
List contacts contact 集合 从已登录用户的默认联系人文件夹中获取联系人集合。
Create contact contact 通过发布到联系人集合创建新联系人。
列出联系人文件夹 ContactFolder 集合 获取已登录用户的默认联系人文件夹中的联系人文件夹集合。
创建联系人文件夹 contactFolder 通过发布到 contactFolders 集合创建新 contactFolder。
个人资料照片
获取 profilePhoto 获取指定的 profilePhoto 或其元数据(profilePhoto 属性)。
更新 更新租户中任何用户的照片,包括已登录用户或指定的组或联系人。
删除 None 删除租户中任何用户(包括已登录用户或指定组)的照片。
计划表
列出收藏计划 plannerPlan 集合 检索由用户标记为收藏的 plannerPlans 列表。
列出最近的计划 plannerPlan 集合 检索用户最近查看的 plannerPlans 列表。
List tasks plannerTask 集合 获取分配给此用户的 plannerTasks。
更新设置 更新 plannerUser 对象的属性。
个人资料
获取 profile 检索给定用户的 profile 对象的属性和关系。
删除 从用户帐户中删除 profile 对象。
赞助商
Assign None 为用户分配发起人。
List directoryObject collection 获取此用户的发起人的用户和组。
Remove None 删除用户的发起人。
列出邀请者 directoryObject 获取邀请指定用户加入租户的用户或服务主体。
Teamwork
列出为用户安装的应用 userScopeTeamsAppInstallation 集合 列出安装在用户个人范围内的应用。
获取为用户安装的应用 userScopeTeamsAppInstallation 列出安装在用户个人范围内的指定应用。
为用户添加应用 在用户的个人范围内添加(安装)应用。
为用户删除应用 删除(卸载)用户个人范围内的应用。
升级为用户安装的应用 将安装在用户个人范围内的应用升级到最新版本。
获取用户和应用之间的聊天 聊天 列出用户和应用之间的一对一聊天。
List permission grants resourceSpecificPermissionGrant 集合 列出用户授予的所有特定于资源的权限
待办任务
列出任务 todoTask 集合 获取指定列表中的所有 todoTask 资源。
创建任务 todoTask 在指定的任务列表中创建 todoTask
列出任务列表 todoTaskList 集合 获取用户邮箱中的所有任务列表。
创建任务列表 todoTaskList 在用户的邮箱中创建微软待办任务列表。
用户设置
获取 userSettings 阅读用户和组织设置对象。
更新 userSettings 更新 settings 对象的属性。

属性

重要

仅当使用设置为 eventual$countConsistencyLevel 标头时,才支持 $filter$search 查询参数的特定用法。 有关详细信息,请参阅 目录对象的高级查询功能

属性 类型 说明
aboutMe String 供用户描述自己的任意格式文本输入字段。

仅在 $select 上返回。
accountEnabled Boolean 启用帐户时为 true,否则为 false。 创建用户时此属性是必需的。

支持 $filtereqnenotin)。
ageGroup ageGroup 设置用户的年龄组。 允许的值: nullMinorNotAdultAdult。 有关详细信息,请参阅 法定年龄组属性定义

支持 $filtereqnenotin)。
assignedLicenses assignedLicense collection 已分配给用户的许可证,包括继承的(基于组的)许可证。 此属性不区分直接分配的许可证和继承的许可证。 使用 licenseAssignmentStates 属性标识直接分配的许可证和继承的许可证。

不可为 null。 支持 $filtereqnot/$count eq 0/$count ne 0)。
assignedPlans assignedPlan collection 分配给该用户的计划。 只读。 不可为 null。

支持 $filtereqnot)。
authorizationInfo authorizationInfo 可用于在非 Azure AD 环境中标识用户并对其进行身份验证的标识符。 此属性可以存储用户用于访问本地 Active Directory部署或联合访问的基于智能卡的证书的标识符。 它还可用于存储与通用访问卡 (CAC) 关联的主题备用名称 (SAN) 。 可为 Null。

支持 $filtereqstartsWith)。
birthday DateTimeOffset 用户的生日。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z

仅在 $select 上返回。
businessPhones String collection 用户的电话号码。 仅可为此属性设置一个数字。

对于从本地目录同步的用户而言为只读。 支持 $filtereqnotgelestartsWith)。
城市 String 用户所在的城市。 最大长度为 128 个字符。

支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
cloudLicensing microsoft.graph.cloudLicensing.userCloudLicensing 用户与云许可资源的关系。
cloudRealtimeCommunicationInfo cloudRealtimeCommunicationInfo Microsoft与用户相关的实时通信信息。
支持 $filter (eq、、 nenot) 。
CompanyName String 用户与之关联的公司的名称。 此属性可用于描述外部用户所属的公司。 最大长度为 64 个字符。

支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
consentProvidedForMinor consentProvidedForMinor 设置是否已获得未成年人的同意。 允许的值:nullGrantedDeniedNotRequired。 请参阅法定年龄组属性定义以了解详细信息。

支持 $filtereqnenotin)。
country String 用户所在的国家或地区;例如, USUK。 最大长度为 128 个字符。

支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
createdDateTime DateTimeOffset 以 ISO 8601 格式和 UTC 创建用户的日期和时间。 值无法修改,并在实体创建时自动填充。 可为 Null。 对于本地用户,值表示首次在 Microsoft Entra ID 中创建用户。 null属性适用于 2018 年 6 月之前创建的一些用户,以及 2018 年 6 月之前同步到Microsoft Entra ID的本地用户。 只读。

支持 $filtereqnenotgelein)。
creationType 字符串 指示是否通过以下方法之一创建用户帐户:
  • 作为常规学校或工作帐户(null)。
  • 作为外部帐户(Invitation)。
  • 作为 Azure Active Directory B2C 租户的本地帐户(LocalAccount)。
  • 通过使用电子邮件验证由内部用户(EmailVerified)进行自助注册。
  • 通过由外部用户通过属于用户流的链接注册的自助注册(SelfServiceSignUp)。

只读。
支持 $filtereqnenotin)。
customSecurityAttributes customSecurityAttributeValue 保留分配给目录对象的自定义安全属性的值的开放式复杂类型。 可为 NULL。

仅在 $select 上返回。 支持 $filtereqnenotstartsWith)。 筛选器值区分大小写。
  • 若要读取此属性,必须为调用应用分配 CustomSecAttributeAssignment.Read.All 权限。 若要编写此属性,必须为调用应用分配 CustomSecAttributeAssignment.ReadWrite.All 权限。
  • 若要在委派方案中读取或写入此属性,必须为管理员分配 属性分配管理员 角色。

    支持 $filtereqnenotgelein)。
  • deletedDateTime DateTimeOffset 删除用户的日期和时间。

    支持 $filtereqnenotgelein)。
    部门 String 用户所在的部门的名称。 最大长度为 64 个字符。

    支持 $filtereqnenotgeleinnull 值上的 eq)。
    displayName String 用户通讯簿中显示的名称。 此值通常是用户名字、中间名首字母和姓氏的组合。 创建用户时需要此属性,在更新期间无法清除此属性。 最大长度为 256 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)、$orderby$search
    employeeHireDate DateTimeOffset 用户被雇用或开始工作的日期和时间(如果有未来雇用)。

    支持 $filtereqnenotgelein)。
    employeeLeaveDateTime DateTimeOffset 用户离开或将离开组织的日期和时间。
  • 若要读取此属性,必须为调用应用分配 User-LifeCycleInfo.Read.All 权限。 若要编写此属性,必须为调用应用分配 User.Read.AllUser-LifeCycleInfo.ReadWrite.All 权限。
  • 若要在委派方案中读取此属性,管理员至少需要以下Microsoft Entra角色之一:生命周期工作流管理员 (最低特权) 全局读取者。 若要在委派方案中编写此属性,管理员需要 全局管理员 角色。

    支持 $filtereqnenotgelein)。

    有关详细信息,请参阅 为用户配置 employeeLeaveDateTime 属性
  • employeeId String 由组织分配给该用户的员工标识符。 最大长度为 16 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    employeeOrgData employeeOrgData 表示组织数据 (例如,与用户关联的部门和 costCenter) 。

    支持 $filtereqnenotgelein)。
    employeeType String 捕获企业员工类型。 例如,EmployeeContractorConsultantVendor。 支持 $filtereqnenotgeleinstartsWith)。
    externalUserConvertedOn DateTimeOffset 用户从外部转换为内部的日期和时间。
    externalUserState String 对于使用邀请 API 邀请到租户的外部用户,此属性表示受邀用户的邀请状态。 对于受邀用户,状态可以是 PendingAcceptanceAccepted,而对于所有其他用户,状态为 null

    支持 $filtereqnenotin)。
    externalUserStateChangeDateTime String 显示对 externalUserState 属性的最新更改的时间戳。

    支持 $filtereqnenotin)。
    faxNumber String 用户的传真号。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    givenName String 用户的名。 最大长度为 64 个字符。 支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    hireDate DateTimeOffset 用户的雇佣日期。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z

    仅在 $select 上返回。
    注意: 此属性特定于 SharePoint Online。 建议使用本地 employeeHireDate 属性来设置和更新使用 Microsoft Graph API 的聘用日期值。
    id String 用户的唯一标识符。 应将其视为不透明的标识符。 继承自 directoryObject。 不可为空。 只读。

    支持 $filtereqnenotin)。
    identities objectIdentity 集合 表示可用于登录此用户帐户的标识。 标识可由Microsoft (也称为本地帐户) 、组织或社交标识提供者(如 Facebook、Google 和 Microsoft)提供,并绑定到用户帐户。 它可能包含具有相同 signInType 值的多个项。

    支持 $filter 有限制的 eq () 。
    imAddresses String collection 即时消息语音 IP (VOIP) 会话启动协议 (用户的 SIP) 地址。 只读。 支持 $filtereqnotgelestartsWith)。
    infoCatalogs 字符串集合 标识分配给用户的信息片段。 支持 $filtereqnotgelestartsWith)。
    interests String collection 供用户描述其兴趣的列表。

    仅在 $select 上返回。
    isLicenseReconciliationNeeded 布尔值 指示用户是否正在等待交换邮箱许可证分配。

    只读。

    支持 $filter 仅) eqtrue (。
    isManagementRestricted 布尔值 true 如果用户是受限管理管理单元的成员,则为 。 默认值为 false。 只读。

    若要管理属于受限管理管理单元成员的用户,必须在受限管理管理单元的范围内为管理员或调用应用分配Microsoft Entra角色。
    isResourceAccount 布尔 请勿使用 – 保留以备今后使用。
    jobTitle String 用户的职务。 最大长度为 128 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    lastPasswordChangeDateTime DateTimeOffset 当此Microsoft Entra用户上次更改其密码或创建其密码时,以执行最新操作的日期为准。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 只读。

    仅在 $select 上返回。
    legalAgeGroupClassification legalAgeGroupClassification 由企业应用程序用于确定用户的法定年龄组。 此属性为只读,并且基于 ageGroupconsentProvidedForMinor 属性进行计算。 允许的值:null、、MinorWithOutParentalConsentMinorWithParentalConsentMinorNoParentalConsentRequiredNotAdult、 和 Adult。 有关详细信息,请参阅 法定年龄组属性定义

    仅在 $select 上返回。
    licenseAssignmentStates licenseAssignmentState 集合 此用户的许可证分配状态。 它还指示直接分配的许可证以及用户通过组成员身份继承的许可证。 只读。

    仅在 $select 上返回。
    mail String 用户的 SMTP 地址,例如, admin@contoso.com。 对此属性的更改还会更新用户的 proxyAddresses 集合,以将值包含为 SMTP 地址。 此属性不能包含重音字符。
    注意: 建议不要为 Azure AD B2C 用户配置文件更新此属性。 请改用 otherMails 属性。

    支持 $filtereqnenotgeleinstartsWithendsWithnull 值上的 eq)。
    mailboxSettings mailboxSettings 已登录用户的主邮箱的设置。 可以获取更新用于向传入邮件发送自动答复、区域设置和时区的设置。 有关详细信息,请参阅 语言和区域格式的用户首选项

    仅在 $select 上返回。
    mailNickname String 用户的邮件别名。 创建用户时必须指定此属性。 最大长度为 64 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    mobilePhone String 用户的主要移动电话号码。 从本地目录同步的用户为只读。

    支持 $filter) gelenotnestartsWitheqineq 的值上 null (、 和 。$search
    mySite String 用户网站的 URL。

    仅在 $select 上返回。
    officeLocation String 用户公司地点的办公室位置。 最大长度为 128 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    onPremisesDistinguishedName String 包含本地 Active Directory distinguished nameDN
    onPremisesDomainName String 包含从本地目录同步的本地 domainFQDN(也称为 dnsDomainName)。
    onPremisesExtensionAttributes onPremisesExtensionAttributes 包含用户的 extensionAttributes1-15。 这些扩展属性也称 Exchange 自定义属性 1-15。 每个属性最多可以存储 1024 个字符。
  • 对于 onPremisesSyncEnabled 用户,这组属性集的授权来源是本地,并且为只读。
  • 对于) onPremisesSyncEnabledfalse 的仅限云用户 (,可以在创建或更新用户对象期间设置这些属性。
  • 对于以前从本地 Active Directory 同步的仅限云用户,这些属性在 Microsoft Graph 中为只读,但可以通过 Exchange 管理中心或 PowerShell 中的 Exchange Online V2 模块进行完全托管。

  • 支持 $filtereqnenotin)。
    onPremisesImmutableId String 此属性将本地 Active Directory用户帐户与其Microsoft Entra用户对象相关联。 如果将联合域用于用户的 userPrincipalName (UPN) 属性,则必须在 Graph 中创建新用户帐户时指定此属性。 注意: 指定 $ 此属性时,不能使用 和 _ 字符。

    支持 $filtereqnenotgelein)。
    onPremisesLastSyncDateTime DateTimeOffset 表示上一次对象与本地目录同步的时间;例如:“2013-02-16T03:04:54Z”。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 只读。

    支持 $filtereqnenotgelein)。
    onPremisesProvisioningErrors onPremisesProvisioningError 集合 在预配期间使用 Microsoft 同步产品时发生的错误。
    支持 $filtereqnotgele)。
    onPremisesSamAccountName String 包含从本地目录同步的本地 sAMAccountName

    支持 $filtereqnenotgeleinstartsWith)。
    onPremisesSecurityIdentifier String 包含从本地同步到云的用户的本地安全标识符 (SID) 。 必须采用 SID 的格式,例如“S-1-5-21-1180699209-877415012-3182824384-1006”。 支持 $filtereq包括在 null 值上)。
    onPremisesSipInfo onPremisesSipInfo 包含与用户相关的所有本地会话初始协议 (SIP) 信息。 只读。
    onPremisesSyncEnabled Boolean true如果当前正在从 本地 Active Directory (AD) 同步此用户对象,则为 ;否则,不会同步该用户,并且可以在 Microsoft Entra ID 中管理。 只读。

    支持 $filtereqnenotinnull 值上的 eq)。
    onPremisesUserPrincipalName String 包含从本地目录同步的本地 userPrincipalName

    支持 $filtereqnenotgeleinstartsWith)。
    otherMails 字符串集合 用户的其他电子邮件地址列表;例如:["bob@contoso.com", "Robert@fabrikam.com"]
    注意:此属性不能包含重音字符。

    支持 (、、、 in/$count eq 0startsWith/$count ne 0endsWithlege) 。 noteq$filter
    passwordPolicies String 指定用户的密码策略。 此值表示枚举,其中一个可能 DisableStrongPassword为枚举值,允许指定超过默认策略的密码。 DisablePasswordExpiration 也可以指定 。 可同时指定两者;例如: DisablePasswordExpiration, DisableStrongPassword。 有关默认密码策略的详细信息,请参阅Microsoft Entra密码策略

    支持 $filternenotnull 值上的 eq)。
    passwordProfile passwordProfile 指定用户的密码配置文件。 配置文件包含用户的密码。 创建用户时此属性是必需的。 配置文件中的密码必须满足 passwordPolicies 属性指定的最低要求。 默认情况下,必须使用强密码。

    支持 $filtereqnenotinnull 值上的 eq)。

    若要更新此属性,请:
  • 在委派访问中,必须代表已登录用户为调用应用分配 User-PasswordProfile.ReadWrite.All 委托权限。
  • 在仅限应用程序访问中,必须为调用应用分配 User-PasswordProfile.ReadWrite.All 应用程序权限,并至少分配用户管理员Microsoft Entra角色
  • pastProjects String collection 供用户枚举其过去项目的列表。

    仅在 $select 上返回。
    postalCode String 用户邮政地址的邮政编码。 邮政编码特定于用户所在的国家/地区。 在美国,此属性包含邮政编码。 最大长度为 40 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    preferredDataLocation String 用户的首选数据位置。 有关详细信息,请参阅 OneDrive Online 多地理位置
    preferredLanguage String 用户的首选语言。 首选语言格式基于 RFC 4646。 该名称结合了与语言关联的 ISO 639 双字母小写区域性代码以及与国家或地区关联的 ISO 3166 双字母大写子区域性代码。 示例:“en-US”或“es-ES”。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    preferredName String 用户的首选名称。 不支持。 此属性返回空字符串。

    仅在 $select 上返回。
    provisionedPlans provisionedPlan 集合 为用户设置的计划。 只读。 不可为 null。 支持 $filtereqnotgele)。
    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。

    支持 $filtereqnotgelestartsWithendsWith/$count eq 0/$count ne 0)。
    refreshTokensValidFromDateTime DateTimeOffset 在此时间之前) 颁发的任何刷新令牌或会话令牌 (会话 Cookie 都无效,并且应用程序在使用无效的刷新令牌或会话令牌获取委托访问令牌时收到错误, (访问 Microsoft Graph) 等 API。 如果发生这种情况,应用程序必须通过请求授权的终结点来获取新的刷新令牌。 只读。 使用 invalidateAllRefreshTokens 进行重置。
    responsibilities String collection 供用户枚举其职责的列表。

    仅在 $select 上返回。
    schools String collection 供用户枚举其学习过的学校列表。

    仅在 $select 上返回。
    securityIdentifier 字符串 用户的安全标识符 (SID),用于 Windows 应用场景。

    只读。 默认情况下返回。
    支持 $select$filter (eqnotgelestartsWith)。
    serviceProvisioningErrors serviceProvisioningError 集合 联合服务发布的错误,描述与用户对象中的属性或链接相关的非特定于服务的错误。
    showInAddressList Boolean 请勿在 Microsoft Graph 中使用。 请改为通过Microsoft 365 管理中心管理此属性。 表示是否应将用户包含在 Outlook 全局地址列表中。 请参阅 已知问题
    signInSessionsValidFromDateTime DateTimeOffset 在此时间之前) 颁发的任何刷新令牌或会话令牌 (会话 Cookie 都无效,并且应用程序在使用无效的刷新令牌或会话令牌获取委托访问令牌时收到错误, (访问 Microsoft Graph) 等 API。 如果发生这种情况,应用程序必须通过请求授权的终结点来获取新的刷新令牌。 只读。 使用 revokeSignInSessions 进行重置。
    skills String collection 供用户枚举其技能的列表。

    仅在 $select 上返回。
    signInActivity signInActivity 获取指定用户登录的最后一个登录日期和请求 ID。 只读。

    仅在 $select 上返回。 支持 $filter (eqne、、notge) le不支持任何其他可筛选属性。

    注意:
  • 此属性的详细信息需要Microsoft Entra ID P1 或 P2 许可证以及 AuditLog.Read.All 权限。
  • 如果用户从未登录或上次登录事件在 2020 年 4 月之前,则不会返回此属性。
  • state String 用户地址中的省/市/自治区或省。 最大长度为 128 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    streetAddress String 用户公司地点的街道地址。 最大长度为 1024 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    surname String 用户的姓氏。 最大长度为 64 个字符。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    usageLocation String 两个字母组成的国家/地区代码(ISO 标准 3166)。 对于由于法律要求而分配许可证的用户需要检查国家/地区的服务可用性。 示例包括: USJPGB。 不可为 null。

    支持 $filtereqnenotgeleinstartsWithnull 值上的 eq)。
    userPrincipalName String 用户的用户主体名称 (UPN)。 UPN 是基于 Internet 标准 RFC 822 的用户的 Internet 样式登录名称。 按照惯例,此名称应映射到用户的电子邮件名称。 常规格式为alias@domain,其中域必须存在于租户的已验证域集合中。 创建用户时此属性是必需的。 可从 组织verifiedDomains 属性访问租户的已验证域。
    注意:此属性不能包含重音字符。 仅支持使用以下字符:A - Za - z0 - 9' . - _ ! # ^ ~。 有关允许字符的完整列表,请参阅用户名策略

    支持 $filtereqnenotgeleinstartsWithendsWith) 和 $orderby
    userType String 一个字符串值,可用于对目录中的用户类型进行分类。 可能的值为 MemberGuest

    支持 $filtereqnenotinnull 值上的 eq)。 注意:有关成员和来宾用户的权限的详细信息,请参阅 Microsoft Entra ID 中的默认用户权限是什么?

    提示

    默认情况下返回目录扩展和关联数据;架构扩展和关联数据仅在 上 $select返回;开放扩展和关联数据仅在 上 $expand返回。

    mail 和 proxyAddresses 属性

    mailproxyAddresses 都是与电子邮件相关的属性。 proxyAddresses 是仅与 Microsoft Exchange 服务器相关的地址的集合。 它用于存储绑定到单个邮箱的用户的邮件地址列表。 mail 属性用作用户的电子邮件地址,用于各种目的(包括用户登录),并定义主代理地址。

    可以通过GET 用户 API 检索 mail 和 proxyAddresses。 可以通过更新用户 API 更新邮件,但无法通过 Microsoft Graph 更新 proxyAddresses。 更新用户 的邮件 属性时,它会触发 proxyAddresses 的重新计算,并将新更新的邮件设置为主代理地址,但以下情况除外:

    1. 如果用户具有包含 Microsoft Exchange 的许可证,则其所有代理地址必须属于租户上的已验证域。 任何不属于已验证域的域都将以无提示方式删除。
    2. 如果用户是来宾,并且主代理地址包含来宾 #EXT#用户 UPN 字符串,则不会将用户的邮件设置为主代理地址。
    3. 如果用户是来宾,即使用户不再具有代理地址,也不会删除用户的邮件。

    proxyAddresses 在目录对象(用户、组和组织联系人)中是唯一的。 如果用户 的邮件 属性与另一个对象的 一个 proxyAddresses 冲突,则尝试更新 邮件 会失败,并且 proxyAddresses 属性也不会更新。

    语言和区域格式的用户首选项

    用户资源包含 mailboxSettings 属性,该属性包括用户的首选语言、日期和时间格式、默认时区以及专用于其主要 Exchange 邮箱的其他设置。 这些首选项面向邮件客户端,仅在用户预配了邮箱时才可用。 如果你的方案仅侧重于 Outlook 邮件、日历、联系人或任务,则可以使用 mailboxSettings

    除了 mailboxSettings用户 还包括通过 userSettingsregionalAndLanguageSettings 的关系,这是语言和区域格式设置首选项的超集,任何应用程序都可以使用它来向用户提供最佳的语言和区域格式设置体验。 使用 userSettings 实现跨应用(利用Microsoft Entra用户配置文件来反映相同用户首选项)的一致体验。

    本部分说明Microsoft Entra管理员和企业应用程序开发人员如何使用三个年龄组属性 (legalAgeGroupClassificationageGroupconsentProvidedForMinor) 来满足年龄相关的法规:

    • legalAgeGroupClassification 属性为只读属性。 企业应用程序开发人员使用它来确保根据用户的法定年龄组正确处理用户。 它根据用户的 ageGroupconsentProvidedForMinor 属性进行计算。
    • ageGroupconsentProvidedForMinor 是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。
    calendarView event 集合 日历的日历视图。 只读。 可为 Null。
    calendars calendar 集合 用户的日历。 只读。 可为 Null。
    contactFolders ContactFolder 集合 用户的联系人文件夹。 只读。 可为 Null。
    contacts contact 集合 用户的联系人。 只读。 可为 Null。
    createdObjects directoryObject collection 用户创建的目录对象。 此为只读属性。 可为 Null。
    directReports directoryObject collection 向该用户报告的用户和联系人。 (用户和联系人的经理属性设置为此 user.) 只读。 可为 NULL。 支持 $expand
    驱动器 drive 用户的 OneDrive。 只读。
    drives drive 集合 此用户可用的驱动器集合。 只读。
    events event 集合 用户的事件。 默认为在“默认日历”下显示事件。 此为只读属性。 可为 NULL。
    extensions 扩展集合 为用户定义的开放扩展集合。 支持 $expand。 可为 Null。
    inferenceClassification inferenceClassification 基于替代推断的相关性或重要性的显式指定对用户消息进行相关性分类。
    insights itemInsights 表示用户与工作或学校文档的 OneDrive 等项之间的关系,这些文档使用高级分析和机器学习技术进行计算。 此为只读属性。 可为 NULL。
    invitedBy directoryObject 邀请用户的用户或服务主体。
    joinedGroups group 集合 此为只读属性。 可为空。
    mailFolders mailFolder 集合 用户的邮件文件夹。 只读。 可为 Null。
    manager directoryObject 是此用户的经理的用户或联系人。 只读。 支持 $expand
    memberOf directoryObject collection 用户所属的组、目录角色和管理单元。 此为只读属性。 可为 NULL。 支持 $expand
    joinedTeams 团队 集合 用户所属Microsoft Teams 团队。 此为只读属性。 可为 Null。
    messages message 集合 邮箱或文件夹中的邮件。 只读。 可为 NULL。
    onenote onenote 只读。
    onlineMeetings onlineMeeting 集合 有关会议的信息,包括用于加入会议的 URL、与会者列表和说明。
    outlook outlookUser 用户可用的选择性 Outlook 服务。 只读。 可为 Null。
    ownedDevices directoryObject collection 用户拥有的设备。 只读。 可为 NULL。 支持 $expand
    ownedObjects directoryObject collection 用户拥有的目录对象。 只读。 可为 NULL。 支持 $expand$select嵌套在 和 $expand$filter (/$count eq 0/$count ne 0/$count eq 1/$count ne 1) 。
    pendingAccessReviewInstances accessReviewInstance 集合 导航属性,用于获取待审阅者审批的访问评审列表。
    people person 集合 此为只读属性。 与用户最相关的人员。 集合按与用户的相关性排序,这由用户的通信、协作和业务关系决定。 用户聚合来自邮件、联系人和社交网络的信息。
    permissionGrants resourceSpecificPermissionGrant 集合 列出用户授予的所有特定于资源的权限。
    photo profilePhoto 用户的个人资料照片。 只读。
    photos profilePhoto 集合 不同大小的用户配置文件的集合。 此为只读属性。
    planner plannerUser 用户可用的选择性 Planner 服务。 只读。 可为 Null。
    个人资料 个人资料 表示在租户中描述用户的属性。
    registeredDevices directoryObject collection 已注册的用户的设备。 只读。 可为 NULL。 支持 $expand 并返回最多 100 个对象。
    scopedRoleMemberOf scopedRoleMembership 集合 该用户的作用域角色管理单元成员身份。 只读。 可为 NULL。
    安全 安全 可为 Null。
    settings userSettings 此为只读属性。 可为 Null。
    解决 方案 userSolutionRoot 表示用户的自定义解决方案实体。 只读。 可为 NULL。
    赞助商 directoryObject collection 负责此来宾用户在租户中的特权的用户和组,并更新来宾用户的信息和访问权限。 (HTTP 方法:GET、POST、DELETE.) 。 支持 $expand
    团队合作 userTeamwork 可供用户使用的 Microsoft Teams 功能的容器。 只读。 可为 Null。
    todo todo 表示用户可以使用的微软待办服务。
    transitiveMemberOf directoryObject 集合 组,包括用户所属的嵌套组和目录角色。 可为 NULL。
    transitiveReports directoryObject 集合 用户的可传递报告。 只读。
    usageRights usageRight 集合 表示已授予用户的使用权限。

    JSON 表示形式

    以下 JSON 表示形式显示了资源类型。

    {
      "aboutMe": "String",
      "accountEnabled": true,
      "ageGroup": "String",
      "assignedLicenses": [{"@odata.type": "microsoft.graph.assignedLicense"}],
      "assignedPlans": [{"@odata.type": "microsoft.graph.assignedPlan"}],
      "authorizationInfo": {
        "@odata.type": "microsoft.graph.authorizationInfo"
      },
      "birthday": "String (timestamp)",
      "businessPhones": ["String"],
      "city": "String",
      "cloudLicensing": { "@odata.type": "microsoft.graph.cloudLicensing.userCloudLicensing" },
      "cloudRealtimeCommunicationInfo": {
        "@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
      },
      "companyName": "String",
      "consentProvidedForMinor": "String",
      "country": "String",
      "createdDateTime": "2019-02-07T21:53:13.067Z",
      "creationType": "String",
      "customSecurityAttributes": {
        "@odata.type": "microsoft.graph.customSecurityAttributeValue"
      },
      "deletedDateTime": "String (timestamp)",
      "department": "String",
      "displayName": "String",
      "employeeHireDate": "2020-01-01T00:00:00Z",
      "employeeId": "String",
      "employeeLeaveDateTime": "String (timestamp)",
      "employeeOrgData": {"@odata.type": "microsoft.graph.employeeOrgData"},
      "employeeType": "String",
      "externalUserConvertedOn": "String (timestamp)",
      "externalUserState": "PendingAcceptance",
      "externalUserStateChangeDateTime": "2018-11-12T01:13:13Z",
      "faxNumber": "String",
      "givenName": "String",
      "hireDate": "String (timestamp)",
      "id": "String (identifier)",
      "identities": [{"@odata.type": "microsoft.graph.objectIdentity"}],
      "interests": ["String"],
      "isLicenseReconciliationNeeded": false,
      "isResourceAccount": false,
      "jobTitle": "String",
      "legalAgeGroupClassification": "String",
      "licenseAssignmentStates": [{"@odata.type": "microsoft.graph.licenseAssignmentState"}],
      "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",
      "onPremisesSipInfo": {
        "@odata.type": "microsoft.graph.onPremisesSipInfo"
      },
      "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"],
      "refreshTokensValidFromDateTime": "2019-02-07T21:53:13.084Z",
      "responsibilities": ["String"],
      "schools": ["String"],
      "securityIdentifier": "String",
      "serviceProvisioningErrors": [{"@odata.type": "microsoft.graph.serviceProvisioningXmlError"}],
      "showInAddressList": true,
      "signInSessionsValidFromDateTime": "2019-02-07T21:53:13.084Z",
      "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"}],
      "insights": {"@odata.type": "microsoft.graph.itemInsights"},
      "settings": {"@odata.type": "microsoft.graph.userSettings"},
      "events": [{"@odata.type": "microsoft.graph.event"}],
      "extensions": [{"@odata.type": "microsoft.graph.extension"}],
      "inferenceClassification": {"@odata.type": "microsoft.graph.inferenceClassification"},
      "mailFolders": [{"@odata.type": "microsoft.graph.mailFolder"}],
      "manager": {"@odata.type": "microsoft.graph.directoryObject"},
      "memberOf": [{"@odata.type": "microsoft.graph.directoryObject"}],
      "joinedTeams": [{"@odata.type": "microsoft.graph.group"}],
      "teamwork": {"@odata.type": "microsoft.graph.teamwork"},
      "messages": [{ "@odata.type": "microsoft.graph.message"}],
      "outlook": {"@odata.type": "microsoft.graph.outlookUser"},
      "ownedDevices": [{"@odata.type": "microsoft.graph.directoryObject"}],
      "photo": {"@odata.type": "microsoft.graph.profilePhoto"},
      "photos": [{ "@odata.type": "microsoft.graph.profilePhoto" }],
      "profile": {"@odata.type": "microsoft.graph.profile"},
      "registeredDevices": [{"@odata.type": "microsoft.graph.directoryObject"}],
      "signInActivity": {"@odata.type": "microsoft.graph.signInActivity"}
    }