@sumor/auth

@sumor/auth

轻呈云应用：授权中心

安装

通过 npm 安装:

$ npm install --save @sumor/auth

使用说明

ES6方式

//例如要访问的程序路径为level1.level2.level3
import {level1} from '@sumor/auth';

level1.level2.level3('parameter1');

Node.js CommonJS方式

//例如要访问的程序路径为level1.level2.level3
const {level1} = require('@sumor/auth');

level1.level2.level3('parameter1');

接口文档

api.admin.app.appInfoCreate(parameters) 创建应用

类型

同步函数

参数

• name 应用名
• desc 应用描述
• url 应用URL地址

api.admin.app.appInfoDelete(parameters) 删除应用

类型

同步函数

参数

• id <Array> 应用ID

api.admin.app.appInfoEdit(parameters) 编辑应用

类型

同步函数

参数

• id 应用ID
• desc 应用描述
• url 应用URL地址

api.admin.app.appInfoQuery(parameters) 查询应用

类型

同步函数

参数

• term 查询条件
• skip <Number> 跳过条数
• top <Number> 条数
• sort <String> 排序规则

api.admin.app.appInfoRead(parameters) 获取应用详情

类型

同步函数

参数

• id 编号

api.admin.app.appRoleQuery(parameters) 查询应用角色

类型

同步函数

参数

• appId <String> 应用ID (必填项)
• term <String> 查询条件
• skip <Number> 跳过条数
• top <Number> 条数
• sort <String> 排序规则

api.admin.app.appRoleRead(parameters) 获取应用角色详情

类型

同步函数

参数

• id 编号

api.admin.app.appRoleUserCreate(parameters) 添加应用角色用户

类型

同步函数

参数

• roleId 应用角色ID
• id <Array> 角色用户ID

api.admin.app.appRoleUserDelete(parameters) 删除应用角色用户

类型

同步函数

参数

• id <Array> 角色用户ID

api.admin.app.appRoleUserQuery(parameters) 查询角色用户

类型

同步函数

参数

• roleId <String> 应用角色ID (必填项)
• term 查询条件
• skip <Number> 跳过条数
• top <Number> 条数
• sort <String> 排序规则

api.admin.app.appUserDelete(parameters) 删除应用用户

类型

同步函数

参数

• id <Array> 应用用户ID

api.admin.app.appUserQuery(parameters) 查询应用

类型

同步函数

参数

• appId <String> 应用ID (必填项)
• term 查询条件
• skip <Number> 跳过条数
• top <Number> 条数
• sort <String> 排序规则

api.admin.app.appUserTechnicalCreate(parameters) 创建连接用户

类型

同步函数

参数

• appId 应用ID

api.admin.user.userCreate(parameters) 创建用户

类型

同步函数

参数

• account 用户名
• password 密码

api.admin.user.userDelete(parameters) 删除用户

类型

同步函数

参数

• id <Array> 用户ID

api.admin.user.userEdit(parameters) 编辑用户

类型

同步函数

参数

• id 用户ID
• account 用户名
• password 密码

api.admin.user.userHelp(parameters) 查询用户

类型

同步函数

参数

• term <String> 查询条件
• skip <Number> 跳过条数
• top <Number> 条数
• sort <String> 排序规则

api.admin.user.userQuery(parameters) 查询用户

类型

同步函数

参数

• term <String> 查询条件
• skip <Number> 跳过条数
• top <Number> 条数
• sort <String> 排序规则

api.authorize(parameters)

类型

同步函数

api.info.authorizedApp(parameters)

类型

同步函数

api.login.fetchVerifycode(parameters)

类型

同步函数

api.login.getMobilePrefix(parameters)

类型

同步函数

api.login.getRedirectInfo(parameters)

类型

同步函数

api.login.grant(parameters)

类型

同步函数

api.login.loginByMobileCode(parameters)

类型

同步函数

api.login.loginByPassword(parameters)

类型

同步函数

api.logout(parameters)

类型

同步函数

api.oauth.fetchServiceToken(parameters) 获取服务令牌

类型

同步函数

参数

• appid <String> 应用ID
• user <String> 用户名
• password <String> 密码

api.oauth.fetchTokenInfo(parameters) 读取用户令牌

类型

同步函数

参数

• id 用户令牌ID

api.oauth.fetchUserToken(parameters) 获取用户令牌

类型

同步函数

参数

• code 一次性授权码

api.oauth.sendWechatTemplateMessage(parameters) 发送消息

类型

同步函数

api.oauth.updateAuth(parameters) 更新权限信息

类型

同步函数

参数

• appid 应用ID
• permission <Array> 权限
• role <Array> 角色

api.oauth.users(parameters) 查询用户

类型

同步函数

参数

• skip <Number> 跳过条数
• top <Number> 条数

api.wechat.avatar(parameters)

类型

同步函数

api.wechat.checkCode(parameters)

类型

同步函数

api.wechat.checkRedirect(parameters)

类型

同步函数

api.wechat.event(parameters)

类型

同步函数

api.wechat.register(parameters)

类型

同步函数

api.wechat.requestCode(parameters)

类型

同步函数

await event.context(parameters)

类型

异步函数

await event.route(parameters)

类型

异步函数

await event.serve(parameters)

类型

异步函数