离职员工
本接口用于离职员工。
Tip: 注意:
- 本接口支持tenant_access_token和user_access_token。
- 使用tenant_access_token时,只能在当前应用的通讯录授权范围内离职员工。
- 若员工归属于多个部门,应用需要有员工所有所属部门的权限,才能离职成功。
- 使用user_access_token 时,默认为管理员用户,将校验管理员管理范围。当用户有多个管理员身份均可离职员工时,管理员管理范围取最大集。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/directory/v1/employees/:employee_id |
| HTTP Method | DELETE |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | directory:employee.resign:write 操作员工离职 directory:employee:write 创建、更新、离职、恢复员工 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 directory:employee.base.external_id:read 查看员工自定义 ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
employee_id | string | 要离职的员工的ID。需要与查询参数中的employee_id_type类型保持一致 示例值:"eesdasjd" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
employee_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 企业内在职员工的唯一标识。支持自定义,未自定义时系统自动生成。ID支持修改。 获取employee_id的方式: - 企业管理员在 管理后台 > 组织架构 > 成员与部门 页面,点击 成员详情,查询员工ID - 通过 批量获取员工列表 的接口,通过手机号或邮箱查询员工ID。 - employee_id: 企业内在职员工的唯一标识。支持自定义,未自定义时系统自动生成。ID支持修改。 获取employee_id的方式: - 企业管理员在 管理后台 > 组织架构 > 成员与部门 页面,点击 成员详情,查询员工ID - 通过 批量获取员工列表 的接口,通过手机号或邮箱查询员工ID。默认值: open_id当值为 employee_id,字段权限要求: directory:employee.base.external_id:read 查看员工自定义 ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
options | delete_employee_options | 否 | 接口拓展选项 |
└ resigned_employee_resource_receiver | resigned_user_resouce_receiver | 否 | 离职员工的资源转移方式。 |
└ department_chat_acceptor_employee_id | string | 否 | 部门群接收者。ID值与查询参数中的employee_id_type 对应。 被删除用户为部门群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内第一个入群的人。 示例值:"ou_7dab8a3d3cdcc9da365777c7ad535d62" |
└ external_chat_acceptor_employee_id | string | 否 | 外部群接收者。ID值与查询参数中的employee_id_type 对应。 被删除用户为外部群群主时,转让群主给指定接收者,不指定接收者则默认转让给群内与被删除用户在同一组织的第一个入群的人,如果组织内只有该用户在群里,则解散外部群。 示例值:"eehsdna" |
└ docs_acceptor_employee_id | string | 否 | 文档接收者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其拥有的文档转让给接收者。不指定接收者则将文档资源保留在该用户名下。 示例值:"eehsdna" |
└ calendar_acceptor_employee_id | string | 否 | 日程接收者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其拥有的日程转让给接收者。不指定接收者则将日程资源保留在该用户名下。 示例值:"eehsdna" |
└ application_acceptor_employee_id | string | 否 | 应用接受者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其创建的应用转让给接收者,不指定接收者则保留应用在该用户名下,但该用户无法登录开发者后台进行应用管理,管理员可以在管理后台手动转移应用给其他人。 示例值:"eehsdna" |
└ helpdesk_acceptor_employee_id | string | 否 | 服务台资源接收者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其拥有的服务台资源转让给接收者,不指定接收者时保留服务台资源在该用户名下。 示例值:"eehsdna" |
└ approval_acceptor_employee_id | string | 否 | 审批资源接收者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其拥有的审批资源转让给接收者,不指定接收者时保留审批资源在该用户名下。 示例值:"eehsdna" |
└ email_acceptor_employee_id | string | 否 | 用户邮件资源接收者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其拥有的邮件资源转让给接收者,不指定接受者则保留邮件资源在该用户名下。 示例值:"eehsdna" |
└ minutes_acceptor_employee_id | string | 否 | 妙记接收者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其拥有的妙记资源转让给接收者。如果不指定接收者则将妙记保留在该用户名下。 示例值:"eehsdna" |
└ survey_acceptor_employee_id | string | 否 | 飞书问卷接收者。ID值与查询参数中的employee_id_type 对应。 用户被删除时,其拥有的飞书问卷资源转让给接收者,不指定接收者则直接删除飞书问卷资源。 示例值:"eehsdna" |
└ anycross_acceptor_employee_id | string | 否 | 集成平台资源Owner 示例值:"eehsdna" |
请求体示例
json
{
"options": {
"resigned_employee_resource_receiver": {
"department_chat_acceptor_employee_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
"external_chat_acceptor_employee_id": "eehsdna",
"docs_acceptor_employee_id": "eehsdna",
"calendar_acceptor_employee_id": "eehsdna",
"application_acceptor_employee_id": "eehsdna",
"helpdesk_acceptor_employee_id": "eehsdna",
"approval_acceptor_employee_id": "eehsdna",
"email_acceptor_employee_id": "eehsdna",
"minutes_acceptor_employee_id": "eehsdna",
"survey_acceptor_employee_id": "eehsdna",
"anycross_acceptor_employee_id": "eehsdna"
}
}
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 2221183 | Unable to delete tenant founder | 无法删除租户创建人 |
| 400 | 2221185 | Frequent deletion. User recovered less than an hour ago | 频繁删除。 用户不到一小时前恢复,请一小时后重试 |
| 400 | 2224001 | No permission to operate | 无操作权限,请检查当前应用的权限或企业版本是否是商业专业版本及以上。 |
| 400 | 2224002 | No permission to operate record | 无操作该记录权限,请检查当前应用的数据管理范围的权限或当前应用所操作的成员是否可恢复。 |
| 400 | 2224003 | No permission to operate dependent object | 无操作依赖对象权限,请检查要恢复到的部门是否有权限。 |
