# 删除用户
该接口用于从通讯录删除一个用户信息,可以理解为员工离职。
- 若用户归属部门A、部门B,应用的通讯录权限范围必须包括部门A和部门B才可以删除用户。
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/contact/users/:user_id |
HTTP Method | DELETE |
支持的应用类型 | 仅自建应用 |
权限要求 | 更新通讯录 |
字段权限要求 | 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 获取用户 user ID |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)
名称 | 类型 | 描述 |
---|---|---|
user_id | string | 用户ID,需要与查询参数中的user_id_type类型保持一致。 示例值:"ou_7dab8a3d3cdcc9da365777c7ad535d62" |
# 查询参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:"open_id" 可选值有: * open_id :标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。* union_id :标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。* user_id :标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。默认值: open_id 当值为 user_id ,字段权限要求: 获取用户 user ID |
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | boolean | 是否成功 |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"data": true,
"msg": "操作成功"
}
1
2
3
4
5
6
2
3
4
5
6