Skip to main content
POST
删除角色

限制说明

使用说明

  • 内置角色是虚拟数据,永远不会被删除;对内置角色调用等同空操作。
  • 默认(is_force=false)情况下,只要还有成员持有该角色,调用就会失败并返回 ReferenceExist 错误码,持有成员列在 data.refs 中。设置 is_force=true 可先从所有持有成员解除该角色再删除。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证,请妥善保管。

请求体

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 的操作。