跳到主要内容

用户管理

可操作BDP“账号权限”中的“用户管理”，利用接口完成用户的创建、删除、冻结等操作。

创建账号​

定义：账号创建, 目前只有超级管理员和有权限的管理员能够创建用户
接口：/user/create

请求参数格式：

字段含义格式备注
username用户名string必填
name昵称string必填
mobile手机string必填
email邮箱string
role角色 管理员／普通账户 2:管理员，3:普通账号int必填
sex性别 0:男 1:女int默认为0
position职位string
manage_groups管理组列表json/list当创建的角色为管理员时，必填, 示例：["id1", "id2"]
belong_groups加入的组列表json/list示例： ["id1", "id2"]
password密码string必填
has_dsh_permission是否有仪表盘模块权限 0:NO,1:YESint
has_tb_permission是否有工作表模块权限 0:NO,1:YESint
has_data_permission是否有数据源模块权限 0:NO,1:YESint
has_machine_learning_permission是否有机器学习模块权限 0:NO,1:YESint
has_data_screen_permission是否有数据大屏模块权限 0:NO,1:YESint
has_dsh_manage_permission是否有仪表盘管理模块权限 0:NO,1:YESint
has_date_filter_permission是否有全局日期筛选器编辑权限 0:NO,1:YESint
function_manage是否有功能管理权限 0:NO,1:YESint只对普通管理员有效
tb_manage是否有工作表管理权限 0:NO,1:YESint只对普通管理员有效
data_source_manage是否有数据源管理权限 0:NO,1:YESint只对普通管理员有效
tml_manage是否有模板分发权限 0:NO,1:YESint只对普通管理员有效
account_manage是否有账户管理权限 0:NO,1:YESint只对普通管理员有效

post数据示例如下： 

{
    "username": "huangxiaoming",
    "name": "黄小明",
    "mobile": "18623437635",
    ...
    ...
    
}

返回值（result返回是新创建用户的user_id）：

{
    "status": "0",
    "errstr": "",
    "result": "050a010fb601e0eed5c00829c00b984e",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：

错误码说明
3没有创建账号的权限
1016用户名含非法字符
8003用户名已存在
1012用户数已达到企业上限
1023手机号已存在
1035邮箱已存在

删除账号​

定义：删除创建
接口：/user/delete

请求参数格式：

字段含义格式备注
user_id用户idstring必填

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",  
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：

错误码说明
3没有删除账号的权限

批量删除账号​

定义：批量删除
接口：/user/bulk_delete

请求参数格式：

字段含义格式备注
user_ids用户idstring(json/list)必填

post数据示例如下： 

{
    "user_ids": "[\"user_id1\", \"user_id2\", \"user_id3\"]"
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：

错误码说明
3没有删除账号的权限

查看账号信息​

定义：查看账号信息
接口：/user/info

请求参数格式：

user_id和username至少填一个

字段含义格式备注
user_id用户idstring选填
username用户名string选填

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",  
}

返回值：

{
  "status": "0",
  "errstr": "",
  "result": {
    "username": "dingzhu5",
    "domain": "haizhi",
    "user_id": "55fda946276ff6c1c50b6ddc849aa037",
    "name": "1",
    "mobile": "12763624101",
    "sex": "女",
    "email": "",
    "role": 2,   // 用户角色， 2:管理员 3:普通用户
    "manage_groups":  // 管理的分组， 管理员会返回
    [
      {
        "group_id": "eb915ea1471cc7f02d164eac1236bbb1",
        "group_level": 1,
        "seq": 0,
        "group_name": "肖昆的分组",
        "parent_group_id": "98637b679ada6a72b993ffb303327705",
        "parent_group_name_list": [
          "全公司"
        ]
      }
    ],
    "groups": // 所属的分组
    [
      {
        "group_id": "eb915ea1471cc7f02d164eac1236bbb1",
        "group_level": 1,
        "seq": 0,
        "group_name": "肖昆的分组",
        "parent_group_id": "98637b679ada6a72b993ffb303327705",
        "parent_group_name_list": [
          "全公司"
        ]
      },
      {
        "group_id": "98637b679ada6a72b993ffb303327705",
        "group_level": 0,
        "seq": 0,
        "group_name": "全公司",
        "parent_group_id": "",
        "parent_group_name_list": []
      }
    ],
    "position": "", // 职位
    "enterprise_id": "75a410c3687affdae7b2a81293743c9d",
    "activate_url": "http://master.bdpdev.bdp.cn/api/su/DSXPUCQL", // 激活链接
    "ctime": "2017-02-28 14:29:40"  // 创建时间
  },
  "trcid": "352b05de-471d-3d47-bfd3-5694d4a04ece"
}

错误代码说明：

错误码说明
3没有查看账号的权限
1009用户不存在

修改账号信息​

定义：修改账号信息
接口：/user/modify

请求参数格式：

字段含义格式备注
user_id修改用户idstring必填
name昵称string
mobile手机string
email邮箱string
role角色 管理员／普通账户 2:管理员，3:普通账号int
sex性别 0:男 1:女int
position职位string

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",
    "name": "黄小明",
    "mobile": "18623437635",
    ...
    ...
    
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：

错误码说明
3没有修改账号的权限
1023手机号已存在
1035邮箱已存在

修改账号功能模块​

定义：修改账号功能模块 接口：/user/func_modify

请求参数格式：

字段含义格式备注
user_id修改用户idstring必填
has_dsh_permission是否有仪表盘模块权限 0:NO,1:YESint
has_tb_permission是否有工作表模块权限 0:NO,1:YESint
has_data_permission是否有数据源模块权限 0:NO,1:YESint
has_machine_learning_permission是否有机器学习模块权限 0:NO,1:YESint
has_data_screen_permission是否有数据大屏模块权限 0:NO,1:YESint
has_dsh_manage_permission是否有仪表盘管理模块权限 0:NO,1:YESint
has_date_filter_permission是否有全局日期筛选器编辑权限 0:NO,1:YESint
function_manage是否有功能管理权限 0:NO,1:YESint只对普通管理员有效
tb_manage是否有工作表管理权限 0:NO,1:YESint只对普通管理员有效
data_source_manage是否有数据源管理权限 0:NO,1:YESint只对普通管理员有效
tml_manage是否有模板分发权限 0:NO,1:YESint只对普通管理员有效
account_manage是否有账户管理权限 0:NO,1:YESint只对普通管理员有效

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",
    "has_dsh_permission": 1,
    "has_tb_permission": 0,
    ...
    ...
    
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：
无

账号列表​

定义：获取管辖范围内的账号信息列表
接口：/user/list

请求参数格式：

字段含义格式备注
offset用户列表的起始偏移量，从0开始，即offset:5 是指从从列表里的第六个开始读取int默认为0
limit需要获取的用户数量int默认为100,最多支持1000

post数据示例如下： 

{
    "offset": "0",
    "limit": "10"   
}

返回值：

{
  "status": "0",
  "errstr": "",
  "result": [
    {
      "username": "linhuang",  //用户名
      "role": 2,   //用户角色
      "user_id": "010752fa24bea08c1cafc0b264f140b2",
      "name": "林皇",   
      "is_frozen": 0  //是否冻结，1代表已冻结
    },
    {
      "username": "xiaohuang",
      "role": 3,
      "user_id": "03f8ed18431ce6c5e90e72c76d3b4bb5",
      "name": "小黄",
      "is_frozen": 0
    }
  ],
  "trcid": "4fafcffd-12be-334e-b321-cc1e207ed53a"
}

错误代码说明：
无

冻结账号​

定义：冻结管辖范围内的账号
接口：/user/freeze

请求参数格式：

字段含义格式备注
user_id用户idstring必填

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",  
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：
无

取消账号冻结​

定义：取消冻结管辖范围内的账号
接口：/user/unfreeze

请求参数格式：

字段含义格式备注
user_id用户idstring必填

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",  
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：
无

重置密码​

定义：重置用户密码, 重置后需要用户通过激活链接进入BDP修改密码，激活链接在接口user/info中获取
接口：/user/reset_password

请求参数格式：

字段含义格式备注
user_id用户idstring必填

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c"
}

返回值（result返回是新创建用户的user_id）：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：
无

加入分组​

定义：将用户加入分组 接口：/user/add_to_group

请求参数格式：

字段含义格式备注
user_id用户idstring必填
group_ids分组idstring(json/list)必填

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",
    "group_ids": "[\"group_id1\", \"group_id2\", \"group_id3\"]"
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：

错误码说明
11有不存在或者被删除的分组

从分组中移除​

定义：将用户从分组中移除 接口：/user/remove_from_group

请求参数格式：

字段含义格式备注
user_id用户idstring必填
group_ids分组idstring(json/list)必填

post数据示例如下： 

{
    "user_id": "5cd14116e5d5061d0a22dec7c7d67e4c",  
    "group_ids": "[\"group_id1\", \"group_id2\", \"group_id3\"]"
}

返回值：

{
    "status": "0",
    "errstr": "",
    "result": "",
    "trcid": "1af069f4-bc91-3068-83d1-1f791f7dac88"
}

错误代码说明：
无