存档团队

命名空间:microsoft.graph

存档指定的团队。 存档团队后,用户无法再对团队进行大部分更改。 例如,用户无法再在团队中的任何频道上发送或赞消息;编辑团队的名称或说明;也不编辑其他设置。 但是,仍允许对团队进行成员身份更改。

存档属于异步操作。 异步操作成功完成后,团队就会存档,这可能会在来自此 API 的响应之后发生。

要存档团队,团队和 必须具有一个所有者。

要从存档状态还原团队,请使用 API 取消存档

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

此 API 支持管理员权限。 Microsoft Teams 服务管理员可以访问他们不是其成员的团队。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) TeamSettings.ReadWrite.All Directory.ReadWrite.All、Group.ReadWrite.All
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 TeamSettings.ReadWrite.Group Directory.ReadWrite.All、Group.ReadWrite.All、TeamSettings.ReadWrite.All

注意

  • TeamSettings.ReadWrite.Group 权限使用 特定于资源的许可
  • 仅出于向后兼容性而支持 Group.ReadWrite.All 和 Directory.ReadWrite.All 权限。 建议更新解决方案,以使用上表中列出的替代权限,并避免今后使用这些权限。

HTTP 请求

POST /teams/{id}/archive

请求标头

标头
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权

请求正文

在请求中,可以选择 参数包含在 shouldSetSpoSiteReadOnlyForMembers JSON 正文中,如下所示。

{
    "shouldSetSpoSiteReadOnlyForMembers": true
}

此可选参数定义了是否在与团队关联的 SharePoint Online 网站上将团队成员的权限设置为“只读”。 将其设置为 false 或完全省略正文会导致跳过此步骤。

重要

应用程序上下文不支持 shouldSetSpoSiteReadOnlyForMembers 参数。

响应

如果成功开始存档,此方法将返回一个 202 Accepted 响应代码。 响应还包含标头 Location ,其中包含为处理团队存档而创建的 teamsAsyncOperation 的位置。 可通过向此位置发出 GET 请求,查看存档操作的状态。

示例

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/v1.0/teams/{id}/archive

{
  
}

响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted
Location: /teams({id})/operations({opId})
Content-Type: text/plain
Content-Length: 0