遍历身份源的用户

1. 请求地址：GET /dev/users

2. 接口概述：

   遍历指定身份源下的用户。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   idp	string	身份源id	是
   sub	string	关联的用户id	否	开发商用户池的用户唯一id
   offset	integer	响应结果起始下标	否	默认0
   limit	integer	响应结果的数量	否	默认50，最大1000
   scope	string	结果范围	否	默认basic，支持的值count、basic

   如何遍历？

   scope用法

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/dev/users?idp={idp}&scope=count basic HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "count": 1,
          "list": [
              {
                  "id": 1,
                  "guid": "xxxxx",
                  "name": "nick_name",
                  "enable": true,
                  "login_name": "login_name",
                  "reg_date": "2022-12-05 09:09:57"
              }
          ]
      }
   }

   响应体说明

遍历用户

1. 请求地址：GET /dev/users

2. 接口概述：

   遍历（关联指定授权码）（关联指定客户的）用户列表。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   customerId	integer	客户的唯一标识符	否
   sn	string	授权码	否
   offset	integer	响应结果起始下标	否	默认0
   limit	integer	响应结果的数量	否	默认50，最大1000
   sort	string	结果排序字段	否	指定用户列表排序字段，参数前面加“-”表示结果倒序排列
   searchField	string	查询字段	否	指定查询用户的字段
   search	string	查询内容	否	参数前后加“*”表示模糊查询
   scope	string	结果范围	否	默认basic，支持的值count、basic

   如何遍历？

   scope用法

sort

支持：id，regDate，loginName。sort字段参数前面加“-”表示结果倒序排列。如-id表示按照id降序排列。

search_field、search

search_field与search成对出现，search_field支持：loginName、phone、email、name。search参数前后加“*”表示模糊查询。如search_field=name&search=\*account\*表示模糊查询帐号包含account的用户。

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/dev/users?offset=0&limit=1&scope=count basic&sort=regDate&search_field=loginName&search=*fed* HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "count": 6,
          "list": [
              {
                  "id": 1,
                  "guid": "xxxxx",
                  "name": "nick_name",
                  "enable": true,
                  "login_name": "login_name",
                  "reg_date": "2022-12-05 09:09:57"
              }
          ]
      }
   }

   响应体说明

获取指定用户信息

1. 请求地址：GET /dev/users/{guid}

2. 接口概述：

   获取指定用户的信息。

3. 请求参数：

   参数名	参数类型	参数说明	必需	备注
   scope	string	结果范围	否	支持的值all，将返回用户具体的userData数据

   scope用法

   地址参数

   参数名	参数类型	参数说明	必需	备注
   guid	string	用户的guid	是

4. 请求体：

   无

5. 请求示例：

   GET /bitanswer/api/dev/users/{guid} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0,
      "data": {
          "id": 1,
          "guid": "xxxxx",
          "name": "nick_name",
          "enable": true,
          "login_name": "login_name",
          "reg_date": "2022-12-05 09:09:57"
      }
   }

   响应体说明

修改指定用户信息

1. 请求地址：POST /dev/users/{guid}

2. 接口概述：

   修改指定用户的信息。只对传入的值进行修改。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   guid	string	用户的guid	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   email	string	邮箱	否
   logo	string	用户头像地址	否
   phone	string	手机号	否
   login_name	string	帐号	否
   name	string	用户名	是

   参数说明

5. 请求示例：

   POST /bitanswer/api/dev/users/{guid} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "name":"nick_name"
   }

6. 响应示例：

   {
      "status": 0
   }

重置指定用户密码

1. 请求地址：POST /dev/users/{guid}/password/reset

2. 接口概述：

   更新指定用户的密码。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   guid	string	用户的guid	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   password	string	密码	否

5. 请求示例：

   POST /bitanswer/api/dev/users/{guid}/password/reset HTTP/1.1
   Host: back-office-api.bitanswer.cn
   Content-Type: application/json
   bitkey: ••••••
   
   {
      "password":"xxxx"
   }

6. 响应示例：

   {
      "status": 0
   }

删除指定用户

1. 请求地址：DELETE /dev/users/{guid}

2. 接口概述：

   删除指定用户。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   guid	string	用户的guid	是

4. 请求体：

   无

5. 请求示例：

   DELETE /bitanswer/api/dev/users/{guid} HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••

6. 响应示例：

   {
      "status": 0
   }

添加用户关联身份源

1. 请求地址：POST /dev/users

2. 接口概述：

   根据开发商的用户id在指定身份源下查找关联的用户，存在则返回，不存在则新建用户，与身份源进行关联。设置用户的头像地址时，添加或修改用户头像。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   guid	string	用户的guid	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   idp	string	身份源id	是
   sub	string	关联的用户id	是	开发商用户池的用户唯一id
   email	string	邮箱	否
   logo	string	用户头像地址	否
   phone	string	手机号	否
   login_name	string	帐号	否	新建用户时，未传值时将自动生成
   name	string	用户名	是
   source	string	来源	否
   guid	string	用户guid	否	新建用户时，未传值时将自动生成
   id	integer	用户id	否	当id存在时，不新建用户，直接关联用户

   参数说明

5. 请求示例：

   POST /bitanswer/api/dev/users HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••
   
   {
      "idp": "xxxxx",
      "sub": "13000",
      "name": "nick_name"
   }

6. 响应示例：

   {
      "status": 0
   }

添加用户

1. 请求地址：POST /dev/users

2. 接口概述：

   添加用户。设置用户的头像地址时，添加或修改用户头像。

3. 请求参数：

   地址参数

   参数名	参数类型	参数说明	必需	备注
   guid	string	用户的guid	是

4. 请求体：

   参数名	参数类型	参数说明	必需	备注
   email	string	邮箱	否
   logo	string	用户头像地址	否
   phone	string	手机号	否
   login_name	string	帐号	否	新建用户时，未传值时将自动生成
   name	string	用户名	是
   source	string	来源	否
   guid	string	用户guid	否	新建用户时，未传值时将自动生成

   参数说明

   创建用户时，login_name、email、phone至少存在一个。

5. 请求示例：

   POST /bitanswer/api/dev/users HTTP/1.1
   Host: back-office-api.bitanswer.cn
   bitkey: ••••••
   
   {
      "email":"email@123.com",
      "name":"nick_name"
   }

6. 响应示例：

   {
      "status": 0
   }