跳转到主要内容
POST
删除角色

限制说明

使用说明

  • 仍有成员持有该角色时,调用返回 400 ReferenceExist,并在 data.refs 中列出这些成员(kind 为 member);设置 is_force 为 true 会先从所有持有成员解除该角色再删除。
  • 被单点登录配置选为默认角色的角色无法删除,即使设置 is_force 也一样;在单点登录配置中取消选择前,调用会返回 400 ReferenceExist。
  • 角色 ID 不存在或已删除时不做任何操作,调用仍返回成功。
  • 内置角色(2、6、8)不能删除:无论是否设置 is_force,调用都返回 400 InvalidParameter(Preset roles cannot be modified.)。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

删除角色请求。

role_id
integer<uint64>
必填

要删除的角色 ID。可通过 POST /role/list 获取(内置角色:2=Admin,6=Responder,8=Viewer)。

is_force
boolean
默认值:false

为 false(默认)时,只要还有成员持有该角色,删除就会失败并返回 ReferenceExist,持有成员列在 data.refs 中。为 true 时,先从所有持有成员解除该角色再删除。不会跳过单点登录默认角色检查。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

成功时返回的空对象,适用于无实质 payload 的操作。