查看角色列表¶

查看当前工作区中的角色及其可修改状态，为角色管理、授权和继承配置选择目标角色。

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

调用前准备¶

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

请求参数¶

输入示例

curl -X GET "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/iam/roles" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

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

成功响应¶

成功时返回当前工作区的完整角色摘要列表，包括生命周期版本和是否允许修改策略。

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "roles": [
      {
        "role_id": "role-001",
        "role_name": "analyst",
        "description": "数据分析角色",
        "lifecycle_state": "active",
        "lifecycle_version": 3,
        "system_role": false,
        "protected_role": false,
        "policy_mutation_allowed": true
      }
    ],
    "request_id": "req-001",
    "trace_id": "trace-001"
  }
}

字段说明

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.roles	array	当前工作区中的角色。
data.roles[].role_id	string	角色 ID。
data.roles[].role_name	string	角色名称。
data.roles[].description	string	角色说明。
data.roles[].lifecycle_state	string	角色生命周期状态。
data.roles[].lifecycle_version	integer	角色生命周期版本。
data.roles[].system_role	boolean	是否为系统角色。
data.roles[].protected_role	boolean	是否为受保护角色。
data.roles[].policy_mutation_allowed	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 日