查询权限定义¶
查看当前工作区支持的权限资源、操作和授权范围,为配置权限策略或对象授权提供可选项。
GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/iam/permissions/schema
调用前准备¶
请求参数¶
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"
}
}
字段 |
类型 |
说明 |
|---|---|---|
|
string |
请求处理成功时为 |
|
string |
请求处理的说明文本。 |
|
object |
响应数据。 |
|
string |
当前权限 Schema 版本。 |
|
object |
当前 Schema 包含的权限能力标记。 |
|
boolean |
是否包含应用权限操作定义。 |
|
boolean |
是否包含数据库权限操作定义。 |
|
boolean |
是否包含产品操作的权限要求。 |
|
boolean |
是否包含行列权限规则的结构定义。 |
|
boolean |
是否提供数据权限变更的传输合同。 |
|
boolean |
数据库及表的权限授予是否已通过能力验证。 |
|
boolean |
行列权限变更合同是否可用。 |
|
boolean |
行列规则实际执行能力是否已验证。 |
|
object(对象数组) |
资源类型及其支持的范围。 |
|
string |
资源类型。 |
|
string |
结构版本。 |
|
object(对象数组) |
该资源或操作的范围选项。 |
|
string |
策略或范围模式。取值: |
|
boolean |
是否启用。 |
|
string |
范围或角色不可用的原因。可用时为空字符串。 |
|
object(对象数组) |
可用于策略的操作定义。 |
|
string |
权限操作 ID。 |
|
string |
资源类型。 |
|
string |
权限保存目标,例如 application_policy 或 matrixone_adapter。 |
|
boolean |
是否允许向角色授予此操作。 |
|
boolean |
是否为转授权限的操作。 |
|
string |
转授操作对应的目标操作 ID。普通操作为空字符串。 |
|
object(对象数组) |
该资源或操作的范围选项。 |
|
string |
策略或范围模式。取值: |
|
boolean |
是否启用。 |
|
string |
范围或角色不可用的原因。可用时为空字符串。 |
|
string(字符串数组) |
允许的转授范围。 |
|
boolean |
是否允许继承该操作权限。 |
|
boolean |
转授权限是否允许继承。 |
|
string(字符串数组) |
此操作覆盖的其他操作 ID。 |
|
string |
说明。 |
|
object |
操作扩展属性,字符串键值映射。未设置时可能为 null。 |
|
boolean |
是否提供对应的转授操作定义。 |
|
object(对象数组) |
对应的转授操作列表。 |
|
string |
权限操作 ID。 |
|
string |
权限保存目标,例如 application_policy 或 matrixone_adapter。 |
|
string(字符串数组) |
允许的转授范围。 |
|
boolean |
转授权限是否允许继承。 |
|
object(对象数组) |
产品操作及其权限要求。 |
|
string |
权限操作 ID。 |
|
string |
结构版本。 |
|
object(对象数组) |
执行该产品操作需要的权限条件。 |
|
string |
权限条件引用的资源参数名称。 |
|
string |
资源类型。 |
|
string(字符串数组) |
该条件所需的权限操作 ID 列表。可能为 null。 |
|
string |
策略或范围模式。取值: |
|
boolean |
是否只允许直接授予的权限满足该条件。 |
|
object |
权限条件的扩展选项,字符串映射。可能为 null。 |
|
string |
请求关联 ID。 |
|
string |
链路追踪 ID。 |
错误响应¶
{
"code": "ErrIAMSchemaInvalid",
"msg": "服务暂时不可用",
"data": null
}
字段 |
类型 |
说明 |
|---|---|---|
code |
string |
错误代码。 |
msg |
string |
错误信息。 |
data |
null |
—。 |