删除角色¶

删除指定角色。仍被用户绑定、继承关系、资源所有权、授权或待处理变更引用的角色不能删除。

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

调用前准备¶

先选择角色，再查看角色删除影响，确认没有阻塞项。删除前应再次确认该角色确实不再使用。

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

请求参数¶

输入示例

curl -X DELETE "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",
    "reason_code": "role_no_longer_needed",
    "expected_lifecycle_version": 1
  }'

参数说明

路径参数

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

请求体

参数	类型	是否必填	说明
request_id	string	是	请求 ID。
reason_code	string	是	删除原因代码。
expected_lifecycle_version	integer	是	预期角色生命周期版本，必须大于 0。

成功响应¶

成功时角色已经通过最终引用检查并删除，响应返回删除后的角色事实。相同请求 ID 和相同内容重放时不会重复删除。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "role": {
      "workspace_id": "workspace-001",
      "role_id": "role-001",
      "role_name": "analyst",
      "lifecycle_state": "deleted",
      "lifecycle_version": 4,
      "system_role": false
    },
    "idempotent_replay": false
  }
}

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.role	object	删除后的角色事实。
data.role.role_id	string	已删除的角色 ID。
data.role.lifecycle_state	string	删除后的生命周期状态。
data.role.lifecycle_version	integer	删除后的生命周期版本。
data.idempotent_replay	boolean	是否为同一请求的幂等重放。

错误响应¶

响应示例

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

字段说明

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

最后更新于 2026 年 9 月 11 日