查询用户角色绑定

查看指定用户在当前工作区中的角色和默认角色,为调整角色分配提供依据。

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

调用前准备

先选择用户。

准备可访问目标工作区的个人访问令牌和目标工作区 ID。

请求参数

curl -X GET "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"

参数

类型

是否必填

说明

workspace_id

string

是

目标工作区 ID。

user_id

string

是

已接受成员的 IAM 用户 ID,取自用户列表同一条记录的 iam_user_id。

路径中的 user_id 填写用户列表返回的 iam_user_id,且成员必须已接受邀请。列表中的 id 是产品账户 UID,不能替代 iam_user_id。待接受的邀请不能用于此接口。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "user_id": "user-001",
    "binding_version": "binding-v3",
    "request_id": "req-001",
    "trace_id": "trace-001",
    "roles": [],
    "default_role_id": "",
    "default_role_version": 0
  }
}

字段

类型

说明

code

string

成功代码。

msg

string

响应信息。

data

object

本次操作返回的数据。

data.user_id

string

目标用户 ID。

data.roles

object(对象数组)

用户直接绑定的角色列表。没有绑定时返回空数组。

data.roles[].role_id

string

角色 ID。

data.roles[].role_name

string

角色名称。

data.roles[].lifecycle_state

string

生命周期状态。取值为 active、disabled、deleted

data.roles[].lifecycle_version

integer

生命周期版本。

data.roles[].system_role

boolean

是否为系统角色。

data.roles[].selectable

boolean

是否可选。

data.roles[].disabled_reason

string

不可选原因。取值为 空字符串、ROLE_NOT_ACTIVE、ROLE_PROVISIONING_NOT_READY

data.roles[].provisioning_state

string

状态信息。取值为 pending、ready、failed

data.roles[].provisioning_version

integer

成员配置版本。

data.default_role_id

string

当前默认角色 ID。没有默认角色时返回空字符串。

data.default_role_version

integer

当前默认角色版本。没有默认角色时返回 0。

data.binding_version

string

当前角色绑定版本标记。

data.request_id

string

请求关联 ID。

data.trace_id

string

链路追踪 ID。

错误响应

普通错误只有 code、msg,不返回 data:null。存在核心授权错误代码时才可能附带 data,其中包含请求 ID、追踪 ID 和核心错误代码。

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

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

常见 HTTP 错误

HTTP 状态码

错误代码

常见原因

建议操作

400

INVALID_ARGUMENT、ErrParamInvalid、ErrIAMInheritanceInvalid、ErrIAMRoleLifecycleInvalid、ErrIAMRoleDeleteInvalid

请求字段、工作区或操作前置条件无效。

修正参数后再提交。

401

Unauthorized

认证凭据缺失或无效。

检查凭据类型、有效期及认证头。

403

ErrForbidden、ErrWorkspaceAccessDenied、IAM_ERROR_CODE_PERMISSION_DENIED

当前身份或有效角色无执行该操作的权限。

使用有权限的身份,或联系管理员授权。

404

USER_NOT_FOUND、ErrNotFound、ErrIAMResourceNotFound、IAM_ERROR_CODE_RESOURCE_NOT_FOUND

目标对象或所需引用未找到。

核对对象标识、所属工作区和当前状态。

409

IAM_ERROR_CODE_IDEMPOTENCY_CONFLICT、IAM_ERROR_CODE_LIFECYCLE_CONFLICT、ErrIAMInheritanceConflict、ErrIAMRoleDeleteConflict、ErrIAMRoleDeleteResultUnknown、ErrIAMWorkspaceMemberLifecycleResultUnknown

资源状态、请求内容或并发条件冲突。

重新读取当前状态和版本,按实际结果处理。

500

INTERNAL、ErrIAMRoleDeleteFailed、ErrIAMWorkspaceMemberLifecycleFailed、ErrIAMWorkspaceMemberLifecycleIncomplete、ErrIAMRoleWriteFailed

内部处理失败;写操作可能已有部分效果。

保留请求和追踪信息,先核对当前结果。

503

ErrCoreAuthorizeUnavailable、IAM_ERROR_CODE_CORE_AUTHORIZE_UNAVAILABLE、ErrIAMRoleReadUnavailable、ErrIAMRolePermissionViewUnavailable、ErrIAMRoleInheritanceUnavailable、ErrIAMRoleAdministrationUnavailable

业务、运行时或授权依赖暂不可用。

恢复依赖后先核对已有结果,不自动重复写入。

最后更新于