NATSpermission.role.list列出角色

Try it 面板需要启用 JavaScript。

分页返回组织范围或 admin 范围的角色。

Request Payload

消息格式：JSON

Name	Data Type	Required	Description
scope	string	Yes	org / admin
orgId	string	No	scope=org 时的组织 ID
page	number	No	页码，默认 1
pageSize	number	No	每页数量，默认 20，上限 100

type RequestBody = {
  /** org / admin */
  scope: string
  /** scope=org 时的组织 ID */
  orgId?: string
  /** 页码，默认 1 */
  page?: number
  /** 每页数量，默认 20，上限 100 */
  pageSize?: number
}

{
  "scope": "org",
  "orgId": "01JD8SRP1N4T8W6XQ5V9XDL2Y7K",
  "page": 1,
  "pageSize": 20
}

Response Payload

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

Name	Data Type	Required	Description
items	array	Yes	角色列表
total	number	Yes	总数
page	number	Yes	当前页码
pageSize	number	Yes	每页数量

type ResponseBody = {
  /** 角色列表 */
  items: Record<string, unknown>[]
  /** 总数 */
  total: number
  /** 当前页码 */
  page: number
  /** 每页数量 */
  pageSize: number
}

{
  "items": [
    {
      "roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M",
      "name": "开发",
      "description": "研发团队成员",
      "permissions": [
        "repo:read",
        "repo:write",
        "ci:trigger"
      ],
      "builtin": false,
      "createdAt": "2026-09-03T07:00:00Z"
    }
  ],
  "total": 3,
  "page": 1,
  "pageSize": 20
}

Response Code

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

code	Meaning	Notes
0	成功	列出角色

Examples

{ "scope": "org", "orgId": "01JD8SRP1N4T8W6XQ5V9XDL2Y7K", "page": 1, "pageSize": 20 }

{
  "id": "01JD8SWAOZ8B5CY",
  "code": 0,
  "messages": [],
  "result": {
    "items": [
      {
        "roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M",
        "name": "开发",
        "description": "研发团队成员",
        "permissions": ["repo:read", "repo:write", "ci:trigger"],
        "builtin": false,
        "createdAt": "2026-09-03T07:00:00Z"
      }
    ],
    "total": 3,
    "page": 1,
    "pageSize": 20
  }
}