组资源类型

  • 项目

命名空间：microsoft.graph

表示Microsoft Entra组、Microsoft 365 组或安全组。 此资源是允许传入其他属性的开放类型。

继承自 directoryObject。

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

该资源支持：

方法

方法 返回类型 说明
组管理
Create group 组 新建组。 它可以是 Microsoft 365 组、动态组或安全组。
Get group 组 读取 group 对象的属性。
列出组 组 集合 列出 group 对象及其属性。
更新组 无 更新 group 对象的属性。
Upsert 组 组 如果不存在，请创建新组，或更新现有组的属性。
删除组 无 删除组对象。
增量 组集合 获取组的增量更改。
添加成员 None 将成员添加到此组，方法是将 成员 发布到成员导航属性 (仅支持安全组和 Microsoft 365 组) 。
添加所有者 None 通过发布到 owners 导航属性为组添加新所有者（仅支持安全组和 Microsoft 365 组）。
列出 groupLifecyclePolicy groupLifecyclePolicy 集合 列出组生命周期策略。
List members directoryObject 集合 从 members 导航属性中获取此组的直接成员。
List owners directoryObject 集合 从 owners 导航属性中获取此组的所有者。
List transitive members directoryObject 集合 获取属于此组成员（包括嵌套成员）的用户、组和设备。
List transitive memberOf directoryObject 集合 列出此组所属的组。 此操作是可传递的，并包括此组以嵌套方式所属的组。
删除成员 无 通过 members 导航属性，删除 Microsoft 365 组或安全组的成员。
删除所有者 无 通过 owners 导航属性，删除 Microsoft 365 组或安全组的所有者。
assignLicense 组 为组添加或删除订阅。 还可以启用和禁用与订阅相关的特定计划。
续订 布尔值 续订组以更新到期时间。 续订后，组的有效期就会延长策略中定义的天数。
validateProperties JSON 验证 Microsoft 365 组的显示名称或邮件昵称是否符合命名策略。
应用角色分配
列出 appRoleAssignments appRoleAssignment 集合 获取已分配到此组的应用和应用角色。
添加 appRoleAssignment appRoleAssignment 向此组分配一个应用角色。
删除 appRoleAssignment 无。 从此组中删除一个应用角色分配。
Calendar
创建事件 event 通过发布到事件集合新建事件。
获取事件 event 读取 event 对象的属性。
列出事件 event 集合 获取 event 对象集合。
更新事件 无 更新 event 对象的属性。
删除事件 无 删除 event 对象。
列出 calendarView event 集合 获取指定时间范围内的事件集合。
对话
创建对话 conversation 通过发布到对话集合新建对话。
获取对话 conversation 读取 conversation 对象的属性。
列出对话 conversation 集合 获取 conversation 对象集合。
删除对话 无 删除 conversation 对象。
创建线程 conversationThread 创建新的对话线程。
获取线程 conversationThread 读取 thread 对象的属性。
列出线程 conversationThread 集合 获取组的所有线程。
更新线程 无 更新 thread 对象的属性。
删除线程 无 删除 thread 对象。
列出 acceptedSenders directoryObject collection 获取此组的“接受的发件人”列表中的用户或组列表。
添加 acceptedSender directoryObject 将用户或组添加到 acceptSenders 集合。
删除 acceptedSender directoryObject 从 acceptedSenders 集合中删除用户或组。
List rejectedSenders directoryObject collection 获取此组的“遭拒的发件人”列表中的用户或组列表。
Add rejectedSender directoryObject 将新用户或组添加到 rejectedSenders 集合中。
Remove rejectedSender directoryObject 从 rejectedSenders 集合中删除新用户或组。
Create setting groupSetting 基于 groupSettingTemplate 创建设置对象。 POST 请求必须为模板中定义的所有设置提供 settingValues。 此操作只能使用组特定的模板。
目录对象
列出已删除的组 directoryObject collection 检索租户中过去 30 天内被删除的组。
列出用户拥有的已删除组 directoryObject collection 检索租户中最近 30 天内删除的用户所有的组。
获取已删除的组 directoryObject collection 按 ID 检索已删除的组。
恢复已删除的组 directoryObject collection 还原最近 30 天内在租户中删除的组。
永久删除组 directoryObject collection 从租户中永久删除已删除的组。
checkMemberGroups String collection 检查组列表中的成员身份。 此函数可传递。
getMemberGroups String collection 返回此组是其成员的所有组。 此函数可传递。
checkMemberObjects String 集合 检查组、目录角色或管理单元对象列表中的成员身份。 此函数可传递。
getMemberObjects String 集合 返回组所属的所有组和管理单元。 此函数可传递。
组设置
Get setting groupSetting 读取特定设置对象的属性。
List settings groupSetting 集合 列出所有设置对象的属性。
更新设置 无 更新 setting 对象。
删除设置 无 删除 setting 对象。
获取设置模板 无 读取设置模板的属性。
列出设置模板 无 列出所有设置模板的属性。
开放扩展
创建开放扩展 openTypeExtension 创建开放扩展，并将自定义属性添加到新资源或现有资源。
获取开放扩展 openTypeExtension 集合 获取扩展名称标识的开放扩展。
架构扩展
添加架构扩展值 无 创建架构扩展定义，然后使用它向资源添加自定义键入数据。
其他组资源
List photos profilePhoto 集合 获取组的个人资料照片集合。
List plannerPlans plannerPlan 集合 获取组拥有的 Planner 计划。
List permissionGrants resourceSpecificPermissionGrant 集合 列出已授予应用访问组的权限。
用户设置
addFavorite 无 将组添加到登录用户的收藏夹组列表中。 仅支持 Microsoft 365 组。
removeFavorite 无 从登录用户收藏夹组列表中删除组。 仅支持 Microsoft 365 组。
List memberOf directoryObject 集合 通过 memberOf 导航属性，获取此用户为其直接成员的组和管理单元。
List joinedTeams group 集合 获取用户属于其直接成员的相应 Microsoft Teams。
列出关联的团队 associatedTeamInfo 集合 获取 user 与之关联的 Microsoft Teams 中的 associatedTeamInfo 对象的列表。
subscribeByMail 无 将 isSubscribedByMail 属性设置为 true。 使登录用户可以接收电子邮件对话。 仅支持 Microsoft 365 组。
unsubscribeByMail 无 将 isSubscribedByMail 属性设置为 false。 使登录用户无法接收电子邮件对话。 仅支持 Microsoft 365 组。
resetUnseenCount 无 将登录用户自上次访问后未查看的所有帖子的 unseenCount 重置为 0。 仅支持 Microsoft 365 组。

属性

重要

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

属性 类型 说明
allowExternalSenders Boolean 指明组织外部人员能否向群组发送邮件。 默认值为 false。

仅在 $select 上返回。 仅支持"获取组 API"（GET /groups/{ID}）。
assignedLabels assignedLabel 集合 与 Microsoft 365 组关联的敏感度标签对（标签 ID、标签名称）列表。

仅在 $select 上返回。
assignedLicenses assignedLicense 集合 分配给该组的许可证。

仅在 $select 上返回。 支持$filter（eq）。只读。
autoSubscribeNewMembers 布尔值 指示添加到组中的新成员是否将自动订阅接收电子邮件通知。 可以在 PATCH 请求中设置组的这个属性；不要在创建该组的初始 POST 请求中设置它。 默认值为 false。

仅在 $select 上返回。 仅支持"获取组 API"（GET /groups/{ID}）。
classification 字符串 描述组 (的分类，例如低、中或高业务影响) 。 通过基于模板定义创建 ClassificationList 设置 值来 定义此属性的有效值。

默认情况下返回。 支持 $filter（eq、ne、not、ge、le、startsWith）。
createdDateTime DateTimeOffset 组的创建时间戳。 值无法修改，并在组创建时自动填充。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。

默认情况下返回。 只读。
deletedDateTime DateTimeOffset 对于某些Microsoft Entra对象 (用户、组、应用程序) ，如果删除了对象，则首先从逻辑上删除该对象，并且此属性使用删除对象的日期和时间进行更新。 否则此属性为null。 如果对象已还原，则此属性会更新为null。
说明 String 可选的组说明。

默认情况下返回。 支持 $filter（eq、ne、not、ge、le、startsWith）和 $search。
displayName String 组的显示名称。 此属性是在创建组时所必需的，并且在更新过程中不能清除。 最大长度为 256 个字符。

默认情况下返回。 支持 $filter（eq、ne、not、ge、le、in、startsWith 和 null 值上的 eq）、$search 和 $orderby。
expirationDateTime DateTimeOffset 设置的组的过期时间戳。 它 null 适用于安全组，但对于 Microsoft 365 组，它表示组设置为何时过期（如 组LifecyclePolicy 中定义）。 时间戳类型使用 ISO 8601 格式表示日期和时间信息，并且始终采用 UTC 格式。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。

默认情况下返回。 支持 $filter（eq、ne、not、ge、le、in）。 只读。
groupTypes String collection 指定组类型及其成员身份。

如果集合包含 Unified，则组是 Microsoft 365 组;否则，它是安全组或通讯组。 有关详细信息，请参阅组概述。

如果该集合包含 DynamicMembership，则该组具有动态成员身份；否则，成员身份是静态的。

默认情况下返回。 支持 $filter（eq、not）。
hasMembersWithLicenseErrors Boolean 指示此组中是否有该基于组的许可证分配中存在许可证错误的成员。

GET 操作从未返回此属性。 可将它用作 $filter 参数，获取具有许可证错误的成员的组（也就是说，此属性的筛选器为 true）。 请参阅示例。

支持 $filter（eq）。
hideFromAddressLists Boolean 如果该组未显示在 Outlook UI 的某些部分中（“通讯簿”中、用于选择邮件收件人的地址列表中以及用于搜索组的“浏览组”中），则为 true；否则为 false。 默认值为 false。

仅在 $select 上返回。 仅支持"获取组 API"（GET /groups/{ID}）。
hideFromOutlookClients Boolean 如果该组未显示在 Outlook 客户端（如 Outlook for Windows 和 Outlook 网页版）中，则为 true；否则为 false。 默认值为 false。

仅在 $select 上返回。 仅支持"获取组 API"（GET /groups/{ID}）。
id String 组的唯一标识符。

默认情况下返回。 继承自 directoryObject。 键。 不可为 null。 只读。

支持 $filter （eq、 ne、 not、 in）。
isArchived Boolean 当组与团队关联时，此属性将确定团队是否处于只读模式。
要读取此属性，请使用 /group/{groupId}/team 终结点或 获取 团队 API。 要更新此属性，请使用 archiveTeam 和 unarchiveTeam API。
isAssignableToRole Boolean 指示是否可以将此组分配给Microsoft Entra角色。 可选。

此属性只能在创建组时设置，并且不可变。 如果设置为 true，则 securityEnabled 属性也必须设置为 true， 可见性 必须为 Hidden，并且组不能是动态组， (即 groupTypes 不能包含 DynamicMembership) 。

只有全局管理员和特权角色管理员角色中的调用方才能设置此属性。 还必须为调用方分配 RoleManagement.ReadWrite.Directory 权限，以设置此属性或更新此类组的成员身份。 有关详细信息，请参阅使用组管理Microsoft Entra角色分配

使用此功能需要Microsoft Entra ID P1 许可证。 默认情况下返回。 支持 $filter （eq、 ne、 not）。
isSubscribedByMail Boolean 指示登录用户是否订阅接收电子邮件对话。 默认值为 true。

仅在 $select 上返回。 仅支持"获取组 API"（GET /groups/{ID}）。
licenseProcessingState String 指示组许可证分配给所有组成员的状态。 默认值为 false。 只读。 可能的值是：QueuedForProcessing、ProcessingInProgress 和 ProcessingComplete。

仅在 $select 上返回。 只读。
mail String 组的 SMTP 地址，例如“serviceadmins@contoso.com”。

默认情况下返回。 只读。 支持 $filter（eq、ne、not、ge、le、in、startsWith 和 null 值上的 eq）。
mailEnabled 布尔 指定是否为启用邮件的组。 必需。

默认情况下返回。 支持 $filter （eq、 ne、 not）。
mailNickname String 组的邮件别名，它对于组织中的 Microsoft 365 组是唯一的。 最大长度为 64 个字符。 此属性只能包含ASCII 字符集 0 - 127 中的字符，以下除外： @ () \ [] " ; : <> , SPACE。

必需。 默认情况下返回。 支持 $filter (eq、ne、not、ge、le、in、startsWith 和 null 值上的 eq)。
membershipRule String 组为动态组时（groupTypes 包含 DynamicMembership），用于确定该组成员的规则。 有关成员身份规则语法的详细信息，请参阅成员身份规则语法。

默认情况下返回。 支持 $filter（eq、ne、not、ge、le、startsWith）。
membershipRuleProcessingState String 指示动态成员身份处理正在进行中，还是已暂停。 可能的值为 On 或 Paused。

默认情况下返回。 支持 $filter （eq、 ne、 not、 in）。
onPremisesLastSyncDateTime DateTimeOffset 指示组最后一次与本地目录同步的时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息，并且始终处于 UTC 时间。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。

默认情况下返回。 只读。 支持 $filter （eq、 ne、 not、 ge、 le、 in）。
onPremisesProvisioningErrors onPremisesProvisioningError 集合 在预配期间使用 Microsoft 同步产品时发生的错误。

默认情况下返回。 支持 $filter（eq、not）。
onPremisesSamAccountName String 包含从本地目录同步的本地 SAM 帐户名。 仅为通过 Microsoft Entra Connect 将本地目录同步到Microsoft Entra ID的客户填充属性。

默认返回。 支持 $filter （eq、 ne、 not、 ge、 le、 in、 startsWith）。 只读。
onPremisesSecurityIdentifier String 包含从本地同步到云的组的本地安全标识符 (SID) 。

默认情况下返回。 支持 $filter（eq包括在 null 值上）。 只读。
onPremisesSyncEnabled Boolean 如果此组从本地目录同步，则为 true；如果此组最初从本地目录同步，但以后不再同步，则为 false；如果此对象从未从本地目录同步，则为 null（默认值）。

默认情况下返回。 只读。 支持 $filter（eq、ne、not、in 和 null 值上的 eq）。
preferredDataLocation String Microsoft 365 组的首选数据位置。 默认情况下，组继承组创建者的首选数据位置。 若要设置此属性，必须为调用应用授予 Directory.ReadWrite.All 权限，并为用户分配以下Microsoft Entra角色之一：
  • 全局管理员
  • 用户帐户管理员
  • 目录写入程序
  • Exchange 管理员
  • SharePoint 管理员

有关此属性详细信息，请参阅 OneDrive Online 多地理位置。

可为 NULL。 默认情况下返回。
preferredLanguage 字符串 Microsoft 365 组的首选语言。 应遵循 ISO 639-1 代码；例如，en-US。

默认情况下返回。 支持 $filter（eq、ne、not、ge、le、in、startsWith 和 null 值上的 eq）。
proxyAddresses String 集合 指向同一组邮箱的组的电子邮件地址。 例如：["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]。 需要 any 运算符筛选多值属性上的表达式。

默认情况下返回。 只读。 不可为 null。 支持 $filter （eq、 not、 ge、 le、 startsWith、 endsWith、 /$count eq 0、 /$count ne 0）。
renewedDateTime DateTimeOffset 组的上次续订时间戳。 值不能直接修改，只能通过续订服务操作进行更新。 时间戳类型使用 ISO 8601 格式表示日期和时间信息，并且始终采用 UTC 格式。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。

默认情况下返回。 支持 $filter（eq、ne、not、ge、le、in）。 只读。
resourceBehaviorOptions 字符串集合 指定在创建期间可为 Microsoft 365 组设置的组行为。 此属性只能在 POST) (创建过程中设置。 有关可能值的列表，请参阅 Microsoft 365 组行为和预配选项。
resourceProvisioningOptions 字符串集合 指定与 Microsoft 365 组关联的组资源。 可能的值为 Team。 有关详细信息，请参阅 Microsoft 365 组行为和预配选项。

默认情况下返回。 支持 $filter （eq、 not、 startsWith。
securityEnabled 布尔 指定是否为安全组。 必需。

默认情况下返回。 支持 $filter （eq、 ne、 not、 in）。
securityIdentifier 字符串 组的安全标识符，用于 Windows 方案。

默认情况下返回。
serviceProvisioningErrors serviceProvisioningError 集合 联合服务发布的错误，描述有关组对象 中的属性或链接的非暂时性特定于服务的错误。

对于 isResolved 和 serviceInstance) eqnot，支持 $filter (、、 。
theme string 指定 Microsoft 365 组的颜色主题。 可能的值为：Teal、Purple、Green、Blue、Pink、Orange 或 Red。

默认情况下返回。
唯一名称 String 可分配给组并用作备用键的唯一标识符。 不可变。 只读。
unseenConversationsCount Int32 自已登录用户上次访问组以来，已发送一个或多个新帖子的对话计数。 此属性与 unseenCount 相同。

仅在 $select 上返回。
unseenCount Int32 自登录用户上次访问该组以来收到新帖子的对话计数。

仅在 $select 上返回。 仅支持"获取组 API"（GET /groups/{ID}）。
visibility String 指定组的组加入策略和组内容可见性。 可能的值为： Private、 Public或 HiddenMembership。 HiddenMembership 只能在创建组时为 Microsoft 365 组设置。 以后无法更新它。 创建组后，可更新其他可见性值。
如果在 Microsoft Graph 上创建组期间未指定可见性值，则默认情况下会创建 Private 安全组，Microsoft 365 组为 Public。 可分配给角色的组始终为 Private。 若要了解详细信息，请参阅 组可见性选项。

默认情况下返回。 可为 NULL。

组可见性选项

值 说明
公共 任何人均可在不需要所有者许可的情况下加入组。
任何人都可以查看组的属性。
任何人都可以查看组的成员。
私人 需要所有者许可才能加入组。
任何人都可以查看组的属性。
任何人都可以查看组的成员。
HiddenMembership 需要所有者许可才能加入组。
来宾用户无法查看组的属性。
非成员无法查看组的成员。 此设置不会影响组所有者的可见性。
管理员（全局、公司、用户和支持人员）可以查看组的成员资格。
该组显示在全局通讯簿 (GAL) 中。

关系

关系 类型 说明
acceptedSenders directoryObject 集合 允许在此组中创建帖子或日历事件的用户或组列表。 如果此列表非空，则仅允许在此处列出的用户或组发布。
appRoleAssignments appRoleAssignment 集合 表示组已对应用程序授予的应用角色。 支持 $expand。
日历 日历 组日历。 只读。
calendarView event 集合 日历的日历视图。 只读。
conversations 对话 集合 组对话。
createdOnBehalfOf directoryObject 创建组的用户（或应用程序）。 注意：如果用户是管理员，则不设置此关系。 只读。
drive drive 组的默认驱动器。 只读。
drives drive 集合 组的驱动器。 只读。
events 事件 集合 组的日历事件。
extensions 扩展集合 为组定义的开放扩展的集合。 此为只读属性。 可为 NULL。
groupLifecyclePolicies groupLifecyclePolicy 集合 此组的生命周期策略集合。 只读。 可为 NULL。
memberOf directoryObject collection 此组所属的组。 HTTP 方法：GET（支持所有组） 只读。 可为 NULL。 支持 $expand。
members directoryObject 集合 此组的成员，可以是用户、设备、其他组或服务主体。 支持列出成员、添加成员和删除成员操作。 可为 NULL。
支持$expand包括嵌套$select。 例如，/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=members($select=id,userPrincipalName,displayName)。
membersWithLicenseErrors User 集合 在该基于组的许可证分配中存在许可证错误的组成员列表。 只读。
onenote Onenote 只读。
owners directoryObject 集合 组的所有者。 仅限 100 个所有者。 可为 NULL。 如果在创建 Microsoft 365 组时未指定此属性，则会自动将调用用户分配为组所有者。
支持 $filter （/$count eq 0、 /$count ne 0、 /$count eq 1、 /$count ne 1）。 支持 $expand，包括嵌套 $select。 例如，/groups?$filter=startsWith(displayName,'Role')&$select=id,displayName&$expand=owners($select=id,userPrincipalName,displayName)。
photo profilePhoto 组的个人资料照片
photos profilePhoto 集合 组拥有的个人资料照片。 此为只读属性。 可为 NULL。
planner plannerGroup 统一组可能存在的 Planner 资源入口点。
rejectedSenders directoryObject 集合 不允许在此组中创建帖子或日历事件的用户或组列表。 可为空
设置 groupSetting 集合 可以管理此组行为的设置，例如成员是否可以将来宾用户邀请到此组。 可为 NULL。
sites 网站集 此组中的 SharePoint 网站列表。 使用 /sites/root 访问默认站点。
团队 channel 集合 与此组关联的团队。
threads conversationThread 集合 组的对话线程。 可为 NULL。
transitiveMemberOf directoryObject 集合 组是其成员的组（直接或通过嵌套成员身份）。 可为 NULL。
transitiveMembers directoryObject 集合 组的直接成员和可传递成员。 可为 Null。

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "allowExternalSenders": false,
  "acceptedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "assignedLicenses": [{ "@odata.type": "microsoft.graph.assignedLicense" }],
  "autoSubscribeNewMembers": true,
  "calendar": { "@odata.type": "microsoft.graph.calendar" },
  "calendarView": [{ "@odata.type": "microsoft.graph.event" }],
  "classification": "String",
  "conversations": [{ "@odata.type": "microsoft.graph.conversation" }],
  "createdDateTime": "String (timestamp)",
  "createdOnBehalfOf": { "@odata.type": "microsoft.graph.directoryObject" },
  "description": "String",
  "displayName": "String",
  "drive": { "@odata.type": "microsoft.graph.drive" },
  "events": [{ "@odata.type": "microsoft.graph.event" }],
  "groupTypes": ["String"],
  "hasMembersWithLicenseErrors": "Boolean",
  "hideFromAddressLists": false,
  "hideFromOutlookClients": false,
  "id": "String (identifier)",
  "isAssignableRole": false,
  "isSubscribedByMail": true,
  "licenseProcessingState": "String",
  "mail": "String",
  "mailEnabled": true,
  "mailNickname": "String",
  "memberOf": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "members": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "membersWithLicenseErrors": [{ "@odata.type": "microsoft.graph.user" }],
  "onPremisesLastSyncDateTime": "String (timestamp)",
  "onPremisesProvisioningErrors": [
    { "@odata.type": "microsoft.graph.onPremisesProvisioningError" }
  ],
  "onPremisesSecurityIdentifier": "String",
  "onPremisesSyncEnabled": true,
  "owners": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "preferredDataLocation": "String",
  "proxyAddresses": ["String"],
  "photo": { "@odata.type": "microsoft.graph.profilePhoto" },
  "photos": [{ "@odata.type": "microsoft.graph.profilePhoto" }],
  "rejectedSenders": [{ "@odata.type": "microsoft.graph.directoryObject" }],
  "renewedDateTime": "String (timestamp)",
  "resourceBehaviorOptions": ["String"],
  "resourceProvisioningOptions": ["String"],
  "securityEnabled": true,
  "securityIdentifier": "String",
  "serviceProvisioningErrors": [
    { "@odata.type": "microsoft.graph.serviceProvisioningXmlError" }
  ],
  "sites": [{ "@odata.type": "microsoft.graph.site" }],
  "threads": [{ "@odata.type": "microsoft.graph.conversationThread" }],
  "uniqueName": "String",
  "unseenCount": 1024,
  "visibility": "String"
}

相关内容