删除角色
调用该接口删除指定角色。
注意事项
角色内如果有成员,则不支持直接删除。你可以调用查询角色下的所有成员信息接口,查看角色内是否还有成员,如果有,可以调用删除角色下的成员接口,将角色成员删除后,再删除角色。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/contact/v3/functional_roles/:role_id |
| HTTP Method | DELETE |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | contact:functional_role 查看、创建、修改、删除角色及角色成员 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
role_id | string | 角色 ID。获取方式: - 在创建角色时,可从返回结果中获取。 - 企业管理员可以在 管理后台 > 组织架构 > 角色管理 页面,在角色名称右侧获取角色 ID。 示例值:"7vrj3vk70xk7v5r" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 404 | 41202 | role id is not exist | role_id 不存在。请修改为正确的 role_id 后重试。 |
| 400 | 41206 | functional role has members, can not delete | 角色内含有成员,不可删除。你需要先删除角色下的成员,然后重试。 |
更多错误码信息,参见通用错误码。
