GET/api/v1/admin/roles列出管理角色

Try it 面板需要启用 JavaScript。

分页返回全部管理角色。

Request

Headers

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

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

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": "01JD8STA3N7V0X8ZS7X1ZFN4A9Q",
      "name": "用户管理员",
      "description": "用户检索与处置",
      "permissions": [
        "admin:user:manage",
        "admin:user:freeze"
      ],
      "builtin": true,
      "memberCount": 3,
      "createdAt": "2026-09-01T00:00:00Z"
    }
  ],
  "total": 4,
  "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/admin/roles?page=1&pageSize=20
Authorization: Bearer st_7c1f9e05b28d4a63

{
  "id": "01JD8STJ9O4I7K1",
  "code": 0,
  "messages": [],
  "result": {
    "items": [
      {
        "roleId": "01JD8STA3N7V0X8ZS7X1ZFN4A9Q",
        "name": "用户管理员",
        "description": "用户检索与处置",
        "permissions": ["admin:user:manage", "admin:user:freeze"],
        "builtin": true,
        "memberCount": 3,
        "createdAt": "2026-09-01T00:00:00Z"
      }
    ],
    "total": 4,
    "page": 1,
    "pageSize": 20
  }
}