Skip to content

获取角色

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

通过 ID 获取单个工作空间角色,包括名称、类型和描述。

鉴权

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

请求参数

NameTypeRequiredInDescription
workspaceIdStringRequiredpath工作空间业务 ID
roleIdStringRequiredpath角色业务 ID

成功响应

状态码: 200 OK

成功 200
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "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:30:00Z",
    "updatedAt": "2026-03-22T10:30:00Z"
  }
}

响应字段

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

错误响应

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

说明

  • 需要 workspace:role:read 权限。

SlaunchX Internal Documentation