查询权限定义

查看当前工作区支持的权限资源、操作和授权范围,为配置权限策略或对象授权提供可选项。

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

调用前准备

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

请求参数

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

参数

类型

是否必填

说明

workspace_id

string

是

目标工作区 ID。

成功响应

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "schema_version": "schema-v1",
    "capabilities": {
      "application_policy_actions_included": true,
      "matrixone_actions_included": true,
      "operation_requirements_included": true,
      "row_column_rule_schema_included": true,
      "data_privilege_transport_ready": true,
      "database_table_dcl_verified": false,
      "row_column_contract_ready": true,
      "row_column_enforcement_verified": false
    },
    "resources": [],
    "actions": [],
    "operations": [],
    "request_id": "req-001",
    "trace_id": "trace-001"
  }
}

字段

类型

说明

code

string

请求处理成功时为 OK。

msg

string

请求处理的说明文本。

data

object

响应数据。

data.schema_version

string

当前权限 Schema 版本。

data.capabilities

object

当前 Schema 包含的权限能力标记。

data.capabilities.application_policy_actions_included

boolean

是否包含应用权限操作定义。

data.capabilities.matrixone_actions_included

boolean

是否包含数据库权限操作定义。

data.capabilities.operation_requirements_included

boolean

是否包含产品操作的权限要求。

data.capabilities.row_column_rule_schema_included

boolean

是否包含行列权限规则的结构定义。

data.capabilities.data_privilege_transport_ready

boolean

是否提供数据权限变更的传输合同。

data.capabilities.database_table_dcl_verified

boolean

数据库及表的权限授予是否已通过能力验证。

data.capabilities.row_column_contract_ready

boolean

行列权限变更合同是否可用。

data.capabilities.row_column_enforcement_verified

boolean

行列规则实际执行能力是否已验证。

data.resources

object(对象数组)

资源类型及其支持的范围。

data.resources[].resource_type

string

资源类型。

data.resources[].schema_version

string

结构版本。

data.resources[].scope_options

object(对象数组)

该资源或操作的范围选项。

data.resources[].scope_options[].mode

string

策略或范围模式。取值:all、resources、parent、path_prefix。

data.resources[].scope_options[].enabled

boolean

是否启用。

data.resources[].scope_options[].disabled_reason

string

范围或角色不可用的原因。可用时为空字符串。

data.actions

object(对象数组)

可用于策略的操作定义。

data.actions[].action_id

string

权限操作 ID。

data.actions[].resource_type

string

资源类型。

data.actions[].persistence_target

string

权限保存目标,例如 application_policy 或 matrixone_adapter。

data.actions[].grantable

boolean

是否允许向角色授予此操作。

data.actions[].grant_action

boolean

是否为转授权限的操作。

data.actions[].grant_target_action_id

string

转授操作对应的目标操作 ID。普通操作为空字符串。

data.actions[].scope_options

object(对象数组)

该资源或操作的范围选项。

data.actions[].scope_options[].mode

string

策略或范围模式。取值:all、resources、parent、path_prefix。

data.actions[].scope_options[].enabled

boolean

是否启用。

data.actions[].scope_options[].disabled_reason

string

范围或角色不可用的原因。可用时为空字符串。

data.actions[].grant_scope_modes

string(字符串数组)

允许的转授范围。

data.actions[].inheritable

boolean

是否允许继承该操作权限。

data.actions[].grant_inheritable

boolean

转授权限是否允许继承。

data.actions[].covering_action_ids

string(字符串数组)

此操作覆盖的其他操作 ID。

data.actions[].description

string

说明。

data.actions[].attributes

object

操作扩展属性,字符串键值映射。未设置时可能为 null。

data.actions[].grant_supported

boolean

是否提供对应的转授操作定义。

data.actions[].grant_actions

object(对象数组)

对应的转授操作列表。

data.actions[].grant_actions[].action_id

string

权限操作 ID。

data.actions[].grant_actions[].persistence_target

string

权限保存目标,例如 application_policy 或 matrixone_adapter。

data.actions[].grant_actions[].grant_scope_modes

string(字符串数组)

允许的转授范围。

data.actions[].grant_actions[].grant_inheritable

boolean

转授权限是否允许继承。

data.operations

object(对象数组)

产品操作及其权限要求。

data.operations[].action_id

string

权限操作 ID。

data.operations[].schema_version

string

结构版本。

data.operations[].requirements

object(对象数组)

执行该产品操作需要的权限条件。

data.operations[].requirements[].resource_name

string

权限条件引用的资源参数名称。

data.operations[].requirements[].resource_type

string

资源类型。

data.operations[].requirements[].action_ids

string(字符串数组)

该条件所需的权限操作 ID 列表。可能为 null。

data.operations[].requirements[].mode

string

策略或范围模式。取值:read、write、manage、grant。

data.operations[].requirements[].direct_only

boolean

是否只允许直接授予的权限满足该条件。

data.operations[].requirements[].options

object

权限条件的扩展选项,字符串映射。可能为 null。

data.request_id

string

请求关联 ID。

data.trace_id

string

链路追踪 ID。

错误响应

{
  "code": "ErrIAMSchemaInvalid",
  "msg": "服务暂时不可用",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

—。

最后更新于