更新用户角色绑定

更新指定用户的角色和默认角色。提交的角色分配会替换该用户当前的角色绑定。

PUT https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/iam/users/{user_id}/role-bindings

调用前准备

先选择用户，再查看用户角色绑定，确认当前绑定状态。然后选择角色，确定新的角色分配和默认角色。

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

请求参数

输入示例

curl -X PUT "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/iam/users/$USER_ID/role-bindings" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "assigned_role_ids": ["role-001"],
    "default_role_id": "role-001",
    "expected_binding_version": 0,
    "expected_default_role_version": 0,
    "request_id": "req-001",
    "clear_default_role": false
  }'

参数说明

路径参数

参数	类型	是否必填	说明
workspace_id	string	是	目标工作区 ID。
user_id	string	是	要更新角色绑定的用户 ID。

请求体

参数	类型	是否必填	说明
assigned_role_ids	array of string	是	更新后的完整直接角色 ID 列表。
default_role_id	string	否	默认角色 ID。
expected_binding_version	integer	否	当前角色绑定版本；不能小于 0。
expected_default_role_version	integer	否	当前默认角色版本；不能小于 0。
request_id	string	是	调用方生成的幂等请求 ID。
clear_default_role	boolean	否	是否清除默认角色。

该接口会完整替换用户的直接角色绑定。default_role_id 为空且 clear_default_role 为 false 时，请求会被拒绝。要清除默认角色，请将 clear_default_role 设为 true；要保留或更换默认角色，请提交对应的 default_role_id。

成功响应

成功时直接角色绑定和默认角色已在同一事务中更新，并返回新的版本。相同请求 ID 和相同内容重放时不会重复更新。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "user_id": "user-001",
    "assigned_role_ids": ["role-001"],
    "default_role_id": "role-001",
    "binding_version": 4,
    "default_role_version": 3,
    "audit_event_id": "audit-001",
    "idempotent_replay": false,
    "request_id": "req-001",
    "trace_id": "trace-001"
  }
}

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.user_id	string	已更新绑定的用户 ID。
data.assigned_role_ids	array of string	更新后的直接角色 ID。
data.default_role_id	string	更新后的默认角色 ID；已清除时为空。
data.binding_version	integer	更新后的角色绑定版本。
data.default_role_version	integer	更新后的默认角色版本。
data.audit_event_id	string	本次变更的审计事件 ID。
data.idempotent_replay	boolean	是否为同一请求的幂等重放。
data.request_id	string	请求关联 ID。
data.trace_id	string	链路追踪 ID。

错误响应

响应示例

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

字段说明

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

最后更新于 2026 年 9 月 11 日