跳转到主要内容
POST
查看角色列表

限制说明

使用说明

  • 自定义角色(含启用和禁用)排在前面,按 orderby/asc 排序;三个内置角色——2 Admin、6 Responder、8 Viewer——追加在末尾(no_global 为 true 时不返回),并计入 total。
  • 内置角色的 editable 为 false,其 description 随请求语言变化(Accept-Language 请求头,或 locale/lang 查询参数)。

授权

app_key
string
query
必填

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

请求体

application/json

查询角色列表的过滤参数。

orderby
enum<string>

排序字段,默认 updated_at。

可用选项:
created_at,
updated_at
asc
boolean

升序排序,默认 false(降序)。

no_global
boolean

为 true 时排除内置全局角色(Admin、Responder、Viewer),只返回自定义角色。默认 false。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

角色列表结果。