NATSpermission.role.update更新角色

Try it 面板需要启用 JavaScript。

更新角色名称、描述与权限集合（整体替换）。

Request Payload

消息格式：JSON

Name	Data Type	Required	Description
roleId	string	Yes	角色 ID
name	string	No	角色名
description	string	No	角色描述
permissions	array	No	权限标识全集（整体替换）

type RequestBody = {
  /** 角色 ID */
  roleId: string
  /** 角色名 */
  name?: string
  /** 角色描述 */
  description?: string
  /** 权限标识全集（整体替换） */
  permissions?: string[]
}

{
  "roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M",
  "permissions": [
    "repo:read",
    "repo:write",
    "ci:trigger",
    "ci:approve"
  ]
}

Response Payload

回复使用统一信封 {id, code, messages, result}，其 result：

Name	Data Type	Required	Description
roleId	string	Yes	角色 ID
name	string	Yes	角色名
permissions	array	Yes	权限标识列表
createdAt	string	Yes	创建时间

type ResponseBody = {
  /** 角色 ID */
  roleId: string
  /** 角色名 */
  name: string
  /** 权限标识列表 */
  permissions: unknown[]
  /** 创建时间 */
  createdAt: string
}

{
  "roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M",
  "name": "开发",
  "permissions": [
    "repo:read",
    "repo:write",
    "ci:trigger",
    "ci:approve"
  ],
  "createdAt": "2026-09-03T07:00:00Z"
}

Response Code

回复使用统一信封 {id, code, messages, result}，其 code 字段：

code	Meaning	Notes
0	成功	更新角色
2601	角色名已存在	改名后重名
2602	权限标识无效
2604	内置角色不可修改

Examples

{
  "roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M",
  "permissions": ["repo:read", "repo:write", "ci:trigger", "ci:approve"]
}

{
  "id": "01JD8SWCQB0D7EA",
  "code": 0,
  "messages": [],
  "result": {
    "roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M",
    "name": "开发",
    "permissions": ["repo:read", "repo:write", "ci:trigger", "ci:approve"],
    "createdAt": "2026-09-03T07:00:00Z"
  }
}