docs-web-logo
开发文档

删除用户

调用该接口删除企业用户。

请求

基本
请求方式DELETE
请求地址/openapi/v3/contacts/users/:union_id

请求头

名称类型必填描述
Authorizationstring是值格式：Bearer {{access_token}}

调用 API 时，需要通过访问凭证（access_token）进行身份鉴权，不同类型的访问凭证可获取的数据范围不同，参考 获取访问凭证 。

支持鉴权类型：
• 应用级token：以应用身份调用 API，校验应用的数据访问范围。参考 获取企业内部应用access_token。
• 用户级token：以登录用户身份调用 API，校验用户的可见数据范围。参考 获取登录用户access_token。
Content-Typestring是固定值：application/json; charset=utf-8

路径参数

名称类型必填描述
union_idstring是用户ID

请求参数

名称类型必填描述
legaciesarray否资源处理配置数组，用户如果开通指定应用时必填，具体规则如下

注意：OneID支持用户开通不同应用，不同应用目前涉及应用资产不同。所以删除用户时需要配置删除策略来处理不同应用的的资产信息。比如：腾讯文档的文档资产、腾讯乐享的知识库资产。目前规则如下：

应用名称app_type值处理措施
腾讯codebuddy/腾讯workbuddycodebuddy无需配置legacies
腾讯文档doc必须配置legacies，其中resolve_method处理方式三选其一：
• reserve：保留
• transfer：转移
• delete：删除
腾讯乐享lexiang必须配置legacies，其中resolve_method仅支持选择：
• reserve：保留
腾讯健康组学平台omics无需配置legacies
腾讯设计ardot必须配置legacies，其中resolve_method仅支持选择：
• reserve：保留
搜狗输入法sogouinput无需配置legacies
腾讯iOAioa无需配置legacies
腾讯clawProclawPro必须配置legacies，其中resolve_method仅支持选择：
• reserve：保留
腾讯skillhubskillhub无需配置legacies

legacies 对象参数

名称类型必填描述
resolve_methodstring是资源处理方式：
• reserve：保留
• transfer：转移
• delete：删除
transfer_to_entity_typestring否转移目标类型，固定值：user；如果 resolve_method 值为 transfer，则此值必填;resolve_method值为reserve或delete时，无需填写此值
transfer_to_entity_idstring否如果 resolve_method 值为 transfer，则此值必填，为接受资源的人的 unionID;resolve_method值为reserve或delete时，无需填写此值
resourcesarray否资源列表
app_typestring是应用类型 OneID支持用户开通不同应用许可，用户开通不同应用情况下，的填写类型如下：
• codebuddy：腾讯codebuddy/腾讯workbuddy
• doc：腾讯文档
• lexiang：腾讯乐享
• omics：腾讯健康组学平台
• ardot：腾讯设计
• ioa：腾讯iOA
• sogouinput：搜狗输入法
• clawPro：腾讯clawPro

请求体示例

1. 资源转移保留

  1{
  2  "legacies": [
  3    {
  4      "resolve_method": "reserve",
  5      "app_type": "lexiang" //按需填写
  6    }
  7  ]
  8}

2. 资源转移删除

  1{
  2  "legacies": [
  3    {
  4      "resolve_method": "delete",
  5      "app_type": "doc" //按需填写
  6    }
  7  ]
  8}

3. 资源转移到指定用户

  1{
  2  "legacies": [
  3    {
  4      "resolve_method": "transfer",
  5      "transfer_to_entity_type": "user",
  6      "app_type": "doc",  //按需填写
  7      "transfer_to_entity_id": "1082491446717579264"
  8    }
  9  ]
 10}

响应

响应体

  1{
  2  "code": 0,
  3  "msg": "success"
  4}