跳转到主要内容
POST
/
role
/
upsert
创建或更新角色
curl --request POST \
  --url 'https://api.flashcat.cloud/role/upsert?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role_name": "值班管理员",
  "description": "管理值班排班和故障处理。",
  "permission_ids": [
    501,
    502
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "role_id": 150,
    "role_name": "值班管理员"
  }
}

限制说明

项目说明
速率限制每个账户 1,000 次/分钟50 次/秒
权限要求角色管理organization

使用说明

  • 省略 role_id(或置为 0)表示创建;传入已有 ID 表示更新。
  • role_name 须为 1–39 个字符且在账户内唯一。
  • permission_ids 会完整替换角色的权限集合。
  • 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。

授权

app_key
string
query
必填

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

请求体

application/json

创建或更新自定义角色的参数。

role_name
string
必填

角色显示名称,1–39 个字符。

Required string length: 1 - 39
role_id
integer<uint64>

角色 ID,省略或置为 0 表示创建。

description
string

角色描述。

Maximum string length: 499
permission_ids
integer<uint64>[]

要授予的权限 ID 列表,会替换现有权限集合。

响应

成功

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

request_id
string
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
必填

角色创建/更新结果。