1. auth
DataAgent
  • schema
    • 基于数据表推导 schema 配置
      POST
    • 列出所有非内部 Schema
      POST
    • 查询单个 YiAsk Schema 记录
      POST
  • project
    • 通过上传 JSON 文件批量导入配置
      POST
    • 导出 YiAsk 关键集合数据
      POST
    • 初始化 LLM、Embedding、向量库与知识库
      POST
  • database
    • 使用 SemanticDB 连接器测试数据库连通性
      POST
    • 针对指定数据源执行加密 SQL
      POST
    • 调用 sql-formatter 美化 SQL
      POST
    • 获取指定数据源的所有表名
      POST
  • custom-metric
    • 通过自然语言表达式创建自定义指标
  • scene
    • 导入场景市场数据
  • logicform
    • 以当前用户身份执行 Logicform
    • 将 Logicform 转换为自然语言描述
    • 根据执行日志 ID 获取 Logicform 调试信息
    • 运行 Logicform Analyze 流程(归因分析)
  • auth
    • 删除角色
      POST
    • 删除数据范围
      POST
    • 删除资源权限范围
      POST
    • 删除用户
      POST
    • 为角色添加桌面路由
      POST
    • 更新角色
      POST
    • 获取指定用户在 yiask 数据源中的权限信息
      POST
    • 创建角色
      POST
    • 更新用户
      POST
    • 用户登录获取 Token
      POST
    • 管理员为指定用户签发 JWT Token
      POST
    • 根据用户 ID 获取用户完整信息
      GET
    • 批量创建用户
      POST
    • 更新数据范围
      POST
    • 获取角色权限
      POST
    • 配置数据源角色权限
      POST
    • 创建或更新角色并同步权限
      POST
    • 创建数据范围
      POST
    • 更新资源权限范围
      POST
    • 配置表的权限范围
      POST
  • agent
    • 对指定 AI 员工发起或继续会话
    • 直接调用已注册的 AI 工具
    • 检索 Nora 向量语料
    • 重建并同步 Nora 语料到向量存储
    • 触发 SemanticDB 学习,可选流式日志
  • resource
    • 删除 Schema 记录
    • 删除 Property 记录
    • 删除自定义指标记录
    • 更新 Schema 记录
    • 查询单个 Property 记录
    • 创建 Property 记录
    • 更新 Property 记录
    • 查询单个自定义指标记录
    • 更新自定义指标记录
    • 查询所有 Schema 记录
    • 查询所有 Property 记录
    • 查询所有自定义指标记录
    • 创建 Schema 记录
    • 查询单个 Schema 记录
  • metric
    • 获取当前空间的指标视图列表
  • ai-employee
    • 获取当前用户在 YiAsk 聊天页可见的 AI 员工列表
    • 获取 AI 员工市场页列表
  • 数据模型
    • ChatRequest
    • ChatMessage
    • ChatResponse
    • SignInRequest
    • UserRole
    • LogicformRequest
    • GenerateSchemaFromTableRequest
    • IssueUserTokenRequest
    • GenerateSchemaFromTableResponse
    • YiaskCustomMetricCreate
    • InitConfigRequest
    • YiaskCustomMetricUpdate
    • LLMServiceConfig
    • ResourceErrorResponse
    • DBConnectionRequest
    • DBConnectionResponse
    • RunSQLRequest
    • FormatSQLRequest
    • SyncCorpusResponse
    • LogicformExecutionRecord
    • QueryCorpusResponse
    • SceneImportResponse
    • YiaskSchema
    • YiaskPropertyUpdate
    • UserPermissionsResponse
    • MetricViewItem
    • WordSegmentItem
    • YiaskSchemaUpdate
    • YiaskCustomMetric
    • UserDetail
    • YiaskMarketAIEmployee
    • YiaskPropertyCreate
    • SignInResponse
    • YiaskProperty
    • IssueUserTokenResponse
    • YiaskSchemaCreate
    • ResourceListResponse
    • LogicformExecutionResult
    • LogicformExecutionGetResponse
    • YiaskChatAIEmployee
  1. auth

创建或更新角色并同步权限

POST
/yiask_roles:updateOrCreateWithPermissions
创建或更新 YiAsk 角色,同时配置行权限、列权限,并可选地批量创建或更新用户。
users[].dataRowScope 用于声明用户拥有的数据行权限,key 为 schema sid, value 为逗号分隔的 rowId 字符串。服务端会将这些记录同步到 usersYiaskCollections 中间表。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Header 参数

Body 参数application/json必填

示例
{
    "name": "storeOwner",
    "title": "店长",
    "users": [
        {
            "username": "zhangsan",
            "nickname": "张三",
            "email": "zhangsan@example.com",
            "phone": "13800138001",
            "password": "Password123!",
            "dataRowScope": {
                "dim_shops_default": "1",
                "dwd_sales_detail_default": "10,11"
            }
        },
        {
            "username": "lisi",
            "nickname": "李四",
            "email": "lisi@example.com",
            "phone": "13800138002",
            "password": "Password123!",
            "dataRowScope": {
                "dwd_sales_detail_default": "2,3,4"
            }
        }
    ],
    "permissions": {
        "dim_shops_default": {
            "rowPermissions": {
                "allowUsers": {
                    "id": "{{ ctx.state.currentUser.id }}"
                }
            },
            "columnPermissions": {
                "view": [
                    "店铺ID",
                    "店铺名称"
                ]
            }
        },
        "dwd_sales_detail_default": {
            "columnPermissions": {
                "view": null
            },
            "rowPermissions": {
                "allowUsers": {
                    "id": "{{ ctx.state.currentUser.id }}"
                }
            }
        }
    }
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/yiask_roles:updateOrCreateWithPermissions' \
--header 'X-SPACES: default' \
--header 'X-SPACES: {{space}}' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "storeOwner",
    "title": "店长",
    "users": [
        {
            "username": "zhangsan",
            "nickname": "张三",
            "email": "zhangsan@example.com",
            "phone": "13800138001",
            "password": "Password123!",
            "dataRowScope": {
                "dim_shops_default": "1",
                "dwd_sales_detail_default": "10,11"
            }
        },
        {
            "username": "lisi",
            "nickname": "李四",
            "email": "lisi@example.com",
            "phone": "13800138002",
            "password": "Password123!",
            "dataRowScope": {
                "dwd_sales_detail_default": "2,3,4"
            }
        }
    ],
    "permissions": {
        "dim_shops_default": {
            "rowPermissions": {
                "allowUsers": {
                    "id": "{{ ctx.state.currentUser.id }}"
                }
            },
            "columnPermissions": {
                "view": [
                    "店铺ID",
                    "店铺名称"
                ]
            }
        },
        "dwd_sales_detail_default": {
            "columnPermissions": {
                "view": null
            },
            "rowPermissions": {
                "allowUsers": {
                    "id": "{{ ctx.state.currentUser.id }}"
                }
            }
        }
    }
}'

返回响应

🟢200成功
application/json
创建或更新成功
Body

示例
{
    "id": 1,
    "name": "storeOwner",
    "title": "店长",
    "permissions": {
        "dim_shops_default": {
            "rowPermissions": {
                "allowUsers": {
                    "id": "{{ ctx.state.currentUser.id }}"
                }
            },
            "columnPermissions": {
                "view": [
                    "店铺ID",
                    "店铺名称"
                ]
            }
        },
        "dwd_sales_detail_default": {
            "columnPermissions": {
                "view": null
            },
            "rowPermissions": {
                "allowUsers": {
                    "id": "{{ ctx.state.currentUser.id }}"
                }
            }
        }
    }
}
🟠400请求有误
修改于 2026-03-27 07:29:34
上一页
配置数据源角色权限
下一页
创建数据范围
Built with