Skip to content

创建角色

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

在工作空间中创建新的自定义角色。仅 CUSTOM 角色可通过此接口创建;OWNER 角色在创建工作空间时自动生成。

鉴权

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

请求参数

NameTypeRequiredInDescription
workspaceIdStringRequiredpath工作空间业务 ID

请求体

json
{
  "roleName": "编辑者",
  "description": "具有编辑权限的自定义角色"
}

请求示例

json
{
  "roleName": "Editor",
  "description": "Can edit content"
}

成功响应

状态码: 201 Created

201 Created 201
{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2001",
  "message": "CREATED",
  "data": {
    "bizId": "role_abc123def456",
    "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"
}
冲突 409
{
  "success": false,
  "code": "WORKSPACE.ROLE_NAME_EXISTS",
  "message": "A role with this name already exists in the workspace"
}

说明

  • 成功时返回 HTTP 201,响应码为 "2001"
  • 同一工作空间内角色名称重复返回 409 WORKSPACE.ROLE_NAME_EXISTS
  • 需要 workspace:role:write 权限。

SlaunchX Internal Documentation