Skip to content

查询角色列表

GET/web/v1/workspaces/{workspaceId}/roles JWT

列出工作空间中定义的所有角色,包括 OWNER 和 CUSTOM 角色。

鉴权

Auth Chain: WEB Chain — 需要 Authorization: Bearer <jwt> 系统注入的请求头(前端无需处理):X-PORTAL-ACCESS-CODE(Nginx)、X-Request-Id(Gateway)

请求参数

NameTypeRequiredInDescription
workspaceIdStringRequiredpath工作空间业务 ID

成功响应

状态码: 200 OK

返回角色对象数组。

成功 200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": [
    {
      "bizId": "ROLE_OWNER_TEST_001",
      "workspaceBizId": "WS_ROLE_TEST_001",
      "roleName": "所有者",
      "roleType": {
        "value": 10010901,
        "name": "OWNER",
        "code": "OWNER"
      },
      "description": "空间所有者,拥有全部权限",
      "permissionCodes": null,
      "createdAt": "2026-03-22T10:30:00Z",
      "updatedAt": "2026-03-22T10:30:00Z"
    },
    {
      "bizId": "ROLE_CUSTOM_TEST_001",
      "workspaceBizId": "WS_ROLE_TEST_001",
      "roleName": "成员",
      "roleType": {
        "value": 10010902,
        "name": "CUSTOM",
        "code": "CUSTOM"
      },
      "description": "默认成员角色",
      "permissionCodes": null,
      "createdAt": "2026-03-22T10:35:00Z",
      "updatedAt": "2026-03-22T10:35:00Z"
    }
  ]
}

响应项字段

字段类型说明
bizIdString角色唯一业务 ID
workspaceBizIdString所属工作空间业务 ID
roleNameString角色显示名称
roleTypeObject角色类型枚举:OWNER (10010901) 或 CUSTOM (10010902)
descriptionString角色描述
permissionCodesArray权限代码(列表视图中可为空)
createdAtStringISO 8601 创建时间
updatedAtStringISO 8601 最后更新时间

错误响应

未授权 401
{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

说明

  • 每个工作空间至少有一个 OWNER 角色(创建时自动生成)。
  • 需要 workspace:role:read 权限。

SlaunchX Internal Documentation