观远数据开放平台
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
首页官网社区
文档
  • 帮助中心
  • 观远学堂
首页官网社区
文档
  • 帮助中心
  • 观远学堂
7.0.0
  • 7.4.0
  • 7.2.0
  • 7.1.0
  • 7.0.0
  • 7.3.0
  1. 用户
  • 默认模块
    • 开发指南
      • Token 鉴权
      • 常见问题
    • 用户
      • 批量创建用户
        POST
      • 批量删除用户
        POST
      • 批量修改用户属性
        POST
      • 批量查询用户是否存在
        POST
      • 获取用户列表
        POST
      • 修改指定用户状态
        POST
      • 通过指定的用户的loginid查询对应的uid
        POST
      • 将用户添加至用户组
        POST
      • 将用户从用户组删除
        POST
      • 获取指定用户组下直接挂载的用户列表
        POST
      • 获取指定用户直接所属的用户组列表
        POST
      • 用户统一登出
        POST
      • 通过用户属性值查询用户列表
        POST
      • 通过指定用户的loginid登录
        POST
    • 用户组
      • 批量创建用户组
      • 批量修改用户组
      • 删除指定用户组
      • 获取用户组列表
    • 角色
      • 查询某一用户的角色信息
      • 为某一用户增添自定义角色
      • 为某一用户解绑自定义角色
    • 数据集
      • 使用parquet文件更新数据集
      • 获取数据集列表
      • 搜索数据集列表
      • 查询特定数据集的数据结构
      • 批量修改数据集更新方式
      • 获取指定数据集有使用权限的用户列表
      • 上传数据
      • 获取数据集下载授权Token
      • 下载数据集数据
      • 获取数据集数据
      • 创建数据集
      • 更新数据集字段注释
      • 触发数据集读取数据文件并更新
      • 通过 TaskID 查询数据集更新结果
      • 修改数据集schema
      • 更新数据集
      • 修改数据集字段别名
    • 仪表板
      • 获取页面列表
      • 根据页面名称关键词搜索页面
      • 获取指定页面有读权限的用户列表
      • 以树状结构获取页面列表
      • 以PDF或者图片模式导出仪表板
      • 获取仪表板导出文件
    • 订阅预警
      • 下载自定义渠道推送文件
      • 启用/关闭订阅
      • 启用/关闭预警
    • 卡片
      • 获取卡片数据
    • 权限
      • 获取指定用户能访问的页面列表
      • 获取指定用户能访问的数据集列表
      • 修改指定用户与各个页面的访问及归属关系
      • 修改指定用户与各个数据集的访问及归属关系
      • 获取指定用户组能访问的页面列表
      • 获取指定用户组能访问的数据集列表
      • 修改指定用户组与各个页面的访问及归属关系
      • 修改指定用户组与各个数据集的访问及归属关系
      • 通用资源权限授权与解除
    • 资源操作
      • 将指定用户下辖有所有者权限的资源迁移至其他用户组或用户
      • 将指定用户组下有所有者权限的资源迁移至其他用户组或用户
      • 通用资源列表清单
    • 用户登录
      POST
  1. 用户

获取用户列表

POST
/public-api/user/list

请求参数

Body 参数application/json
token
string 
应用Token
必需
在观远平台管理员设置-系统集成-统一账户集成中获得
userPropertyType
enum<number> 
用户属性类型
可选
0:使用key;1:使用名称。默认为0。
枚举值:
01
默认值:
0
示例
{
    "token": "string",
    "userPropertyType": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/public-api/user/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "userPropertyType": 0
}'

返回响应

🟢200成功
application/json
Body
result
string 
必需
response
array [object {13}] 
必需
id
integer 
必需
uId
string 
必需
name
string 
必需
mobile
string 
可选
email
string 
可选
loginId
string 
必需
domId
string 
必需
role
array[string]
必需
config
object 
可选
lastLoginTime
string 
可选
enabled
boolean 
必需
ctime
string 
可选
isDel
boolean 
必需
示例
{
    "result": "ok",
    "response": [
        {
            "id": 760,
            "uId": "m5b7407230a3a4fda87b8f6b",
            "name": "王某某",
            "mobile": "135xxxxxxxx",
            "email": "wmm@guandata.com",
            "loginId": "wmm@guandata.com",
            "domId": "testing",
            "role": [
                "admin"
            ],
            "config": {
                "theme": "LIGHT",
                "locale": "zh-CN",
                "userProperties": {
                    "feishu": "子公司111",
                    "gender": ""
                },
                "userGuideVersion": "6.6.0"
            },
            "lastLoginTime": "2023-05-16 15:15:31+0800",
            "enabled": true,
            "ctime": "2019-08-08 15:54:20+0800",
            "isDel": false
        }
    ]
}
修改于 2025-07-16 01:56:22
上一页
批量查询用户是否存在
下一页
修改指定用户状态