跳转到主要内容
POST
/
role
/
list
查看角色列表
curl --request POST \
  --url 'https://api.flashcat.cloud/role/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderby": "created_at",
  "asc": false
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 3,
    "items": [
      {
        "role_id": 2,
        "role_name": "账户管理员",
        "description": "",
        "status": "enabled",
        "permission_ids": [],
        "editable": false,
        "created_at": 1700000000,
        "updated_at": 1700000000
      }
    ]
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求无 —— 持有有效的 app_key 即可调用

使用说明

  • 内置角色(editable: false)不可修改或删除。

授权

app_key
string
query
必填

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

请求体

application/json

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

orderby
enum<string>

排序字段。

可用选项:
created_at,
updated_at
asc
boolean

升序排序。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

角色列表结果。