GET/api/v1/orgs/:orgId/roles列出组织角色

Try it 面板需要启用 JavaScript。

分页返回指定组织定义的全部角色。

Request

Headers

Name	Data Type	Required	Description
Authorization	string	Yes	会话令牌认证，格式 `Bearer <sessionToken>`

type RequestHeaders = {
  /** 会话令牌认证，格式 `Bearer <sessionToken>` */
  Authorization: string
}

URL Parameters

Name	Data Type	Description
orgId	string	组织 ID

Query Parameters

Name	Data Type	Required	Description
page	number	No	页码，默认 1
pageSize	number	No	每页数量，默认 20，上限 100

type QueryParams = {
  /** 页码，默认 1 */
  page?: number
  /** 每页数量，默认 20，上限 100 */
  pageSize?: number
}

{
  "page": 1,
  "pageSize": 20
}

Response

Body

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"
      ],
      "createdAt": "2026-09-03T07:00:00Z"
    }
  ],
  "total": 3,
  "page": 1,
  "pageSize": 20
}

HTTP Code

HTTP Status	Meaning	Notes
200	成功	返回角色列表

Response Code

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

code	Meaning	Notes
0	成功	返回角色列表

Examples

GET /api/v1/orgs/01JD8SRP1N4T8W6XQ5V9XDL2Y7K/roles?page=1&pageSize=20
Authorization: Bearer st_7c1f9e05b28d4a63

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