onenet-passport v1.0.2

onenet-passport

This is a passport plugin for onenet

Install

npm install onenet-passport --save

Usage

const onenetPassport = require('onenet-passport');

1） 用户名唯一性检查

注：用户名可以是username、email、tel等任意类型

onenetPassport.varifyName(userName)

• 请求返回
  成功

{"code":0,"msg":"succ"}

失败

{"code":100000,"msg":"用户已存在"}

2) 根据用户名获取用户信息

注：用户名可以是username、email、tel等任意类型

onenetPassport.getUserByName('userName')

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"id":1,"user_type":1,"detail":"[]","error_times":0,"reg_time":"2016-06-15 17:10:45","reg_ip":"192.168.8.12","last_login_time":"2016-06-15 17:12:56","last_login_ip":"192.168.8.12","find_skey":null,"find_time":null}}

失败

{"code":100001,"msg":"用户不存在"}

3) 根据用户ID获取用户信息

注：支持批量拉取用户信息，id之间用英文半角的","分割，最多返回100条数据

onenetPassport.getUserById(id)

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"id":1,"user_type":1,"detail":"[]","error_times":0,"reg_time":"2016-06-15 17:10:45","reg_ip":"192.168.8.12","last_login_time":"2016-06-15 17:12:56","last_login_ip":"192.168.8.12","find_skey":null,"find_time":null}}

失败

{"code":100001,"msg":"用户不存在"}

4) 根据用户openId获取用户信息（用于第三方应用获取用户信息）

注：openId在用户登录后即可获得

onenetPassport.getUserById(openId)

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"id":1,"user_type":1,"detail":"[]","error_times":0,"reg_time":"2016-06-15 17:10:45","reg_ip":"192.168.8.12","last_login_time":"2016-06-15 17:12:56","last_login_ip":"192.168.8.12","find_skey":null,"find_time":null}}

失败

{"code":100001,"msg":"用户不存在"}

5) 根据用户名查询用户列表

注：用户名可以是username、email、tel，模糊匹配，最多返回100条数据

onenetPassport.getUserListByName(userName)

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"id":1,"user_type":1,"detail":"[]","error_times":0,"reg_time":"2016-06-15 17:10:45","reg_ip":"192.168.8.12","last_login_time":"2016-06-15 17:12:56","last_login_ip":"192.168.8.12","find_skey":null,"find_time":null}}

失败

{"code":100001,"msg":"用户不存在"}

6) 编辑用户信息

onenetPassport.patch(id, nickname, avatar, detail)

注1 detail作为数组传入，里边可以包含username、email、tel、nickname、avatar以外的其他参数。

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"id":1,"user_type":1,"detail":"[]","error_times":0,"reg_time":"2016-06-15 17:10:45","reg_ip":"192.168.8.12","last_login_time":"2016-06-15 17:12:56","last_login_ip":"192.168.8.12","find_skey":null,"find_time":null}}

失败

{"code":100001,"msg":"用户不存在"}

7) 用户注册

onenetPassport.register(username, userType, regWay, email, tel, password, nickname, avatar)

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"id":1,"user_type":1,"detail":"[]","error_times":0,"reg_time":"2016-06-15 17:10:45","reg_ip":"192.168.8.12","last_login_time":"2016-06-15 17:12:56","last_login_ip":"192.168.8.12","find_skey":null,"find_time":null}}

失败

{"code":999999,"msg":"注册失败"}

8) 用户登录

注：用户名可以是username、email、tel

onenetPassport.login(username, password, loginIp, loginClient)

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"id":1,"user_type":1,"detail":"[]","error_times":0,"reg_time":"2016-06-15 17:10:45","reg_ip":"192.168.8.12","last_login_time":"2016-06-15 17:12:56","last_login_ip":"192.168.8.12","find_skey":null,"find_time":null}}

失败

{"code":100001,"msg":"用户不存在"}

9) 获取token

@params {Object} configParams 获取token的基本参数与信息

onenetPassport.getToken(configParams)

• 接口返回结果

成功

{"code":0,"msg":"succ","data":{"token":"f237c5541e9a066dff6821495adc8c72","expires":"2016-10-19 11:41:49"}}

失败

{"code":500,"msg":"XXXX"}

10) 修改密码

onenetPassport.changePassword(id, oldpass, password)

• 接口返回结果

成功

{"code":0,"msg":"succ","data":NULL}

失败

{"code":500,"msg":"XXXX"}

3、附件1-返回信息列表

4、附件2-注册方式列表