观远数据开放平台
7.2.0
首页
官网
社区
文档
观远数据开放平台
7.2.0
  • 开发指南
  • 用户
    • 批量创建用户POST
    • 批量修改用户属性POST
    • 批量删除用户POST
    • 批量获取用户是否存在POST
    • 获取用户列表POST
    • 通过属性值获取用户列表POST
    • 修改用户状态POST
    • 通过loginId获取用户信息POST
  • 数据集
  • 仪表板
  • 订阅预警
  • 卡片
  • 权限
  • 资源操作
  • 卡片导出
  • session
  • 文件夹
  • 数据账户
  • 身份认证
  • 用户管理
亮色模式

    获取用户列表

    POST/public-api/user/list

    :::note[接口简介]
    查询用户信息列表,是否支持返回用户属性的别名,封装用户属性配置信息的类。
    :::

    请求参数

    Body 参数application/json
    token
    string 
    应用Token
    必需

    在观远平台管理员设置-系统集成-统一账户集成中获得

    userPropertyType
    enum<number> 
    用户属性类型
    可选
    枚举值:
    01
    默认值:
    0
    示例
    {
      "token": "string",
      "userPropertyType": 0
    }

    示例代码

    返回响应

    成功(200)
    HTTP 状态码: 200
    内容格式: JSONapplication/json
    数据结构
    result
    string 
    请求状态
    必需

    枚举值: ok、fail

    response
    array [object {4}] 
    响应结果
    必需
    config
    object 
    用户属性
    可选

    内置属性和自定义属性

    lastLoginTime
    string 
    可选
    ctime
    string 
    创建时间
    可选
    isDel
    boolean 
    是否删除
    必需
    示例
    {
      "result": "ok",
      "response": [
        {
          "id": 760,
          "uId": "m5b7407230a3a4fda87b8f6b",
          "name": "陈珊莹",
          "mobile": "13586102751",
          "email": "sychen@guandata.com",
          "loginId": "sychen@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
        },
        {
          "id": 761,
          "uId": "n130a3d9278784b4d90baae9",
          "name": "史栋",
          "mobile": "",
          "email": "",
          "loginId": "stone@guandata.com",
          "domId": "testing",
          "role": [
            "admin"
          ],
          "config": {
            "userProperties": {
              "feishu": "",
              "gender": ""
            }
          },
          "lastLoginTime": "2021-03-10 14:49:55+0800",
          "enabled": true,
          "ctime": "2019-08-08 16:11:01+0800",
          "isDel": false
        }
      ]
    }
    最后修改时间: 3 天前
    上一页
    POST批量获取用户是否存在
    下一页
    POST通过属性值获取用户列表
    举报