npm package: @sumor/auth
Description: 轻呈云应用：授权中心
Latest version: 17.1.34
Deprecated: SUNSET

# @sumor/auth
轻呈云应用：授权中心

## 安装

通过 [npm](https://www.npmjs.com/) 安装:
```sh
$ npm install --save @sumor/auth
```

## 使用说明

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

level1.level2.level3('parameter1');
```
Node.js CommonJS方式
```js
//例如要访问的程序路径为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)
###### 类型
异步函数