存档团队

命名空间:microsoft.graph

存档指定的团队。 存档团队后,用户无法再团队中的任意频道上发送或点赞消息,无法再编辑团队名称、说明和其他设置,且通常也无法再对团队进行大部分更改。 仍可向团队进行成员身份更改。

存档属于异步操作。 该异步操作成功完成后,团队即已存档,此 API 作出响应后就可能出现此情况。

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

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

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

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

权限

要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限

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

注意

  • 标记为 * 的权限使用 特定于资源的许可
  • 仅支持使用 ** 标记的权限以实现向后兼容性。 建议更新解决方案,以使用上表中列出的替代权限,并避免今后使用这些权限。

注意:此 API 支持管理员权限。 全局管理员和 Microsoft Teams 服务管理员可以访问自己不是其中成员的团队。

HTTP 请求

POST /teams/{id}/archive

请求标头

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

请求正文

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

{
    "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