更新角色¶

更新指定角色的名称和说明。只有仍允许修改的角色才能完成更新。

PATCH https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/iam/roles/{role_id}

调用前准备¶

先选择角色，确认该角色仍允许修改，并以列表中的当前状态为准准备更新。

准备具有目标工作区相应权限的个人访问令牌和目标工作区 ID。

请求参数¶

输入示例

curl -X PATCH "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/iam/roles/$ROLE_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "request_id": "req-001",
    "name": "数据分析师",
    "description": "负责查看分析数据",
    "expected_lifecycle_version": 1
  }'

参数说明

路径参数

参数	类型	是否必填	说明
workspace_id	string	是	目标工作区 ID。
role_id	string	是	目标角色 ID。

请求体

参数	类型	是否必填	说明
request_id	string	是	请求 ID。
name	string	是	角色名称。
description	string	否	更新后的角色说明；省略时保存为空字符串。
expected_lifecycle_version	integer	是	预期角色生命周期版本，必须大于 0。

成功响应¶

成功时返回更新后的角色摘要和新的生命周期版本。相同请求 ID 和相同内容重放时不会重复修改。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "role": {
      "workspace_id": "workspace-001",
      "role_id": "role-001",
      "role_name": "analyst",
      "description": "数据分析角色",
      "lifecycle_state": "active",
      "lifecycle_version": 4,
      "system_role": false
    },
    "idempotent_replay": false
  }
}

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.role	object	更新后的角色摘要。
data.role.lifecycle_version	integer	更新后的角色生命周期版本。
data.idempotent_replay	boolean	是否为同一请求的幂等重放。

错误响应¶

响应示例

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

字段说明

字段	类型	说明
code	string	错误代码。
msg	string	错误信息。
data	null	—

最后更新于 2026 年 9 月 11 日