# uxuser-sdk

> 用户中心sdk

Latest version **1.2.7** (published 2019-09-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install uxuser-sdk
pnpm add uxuser-sdk
yarn add uxuser-sdk
bun add uxuser-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.7 |
| Published | 2019-09-17 |
| First published | 2019-01-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 2 |
| Unpacked size | 32.1 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| Author | wangshuli@cmcm.com |
| Maintainers | shuli495 |
| Keywords | sdk, user, user center, user center sdk |

## Links

- npm: https://www.npmjs.com/package/uxuser-sdk
- Repository: git@git.liebaopay.com:CMUX/ux-uxuser.cmcm.com-sdk
- Homepage: http://git.liebaopay.com/CMUX/ux-uxuser.cmcm.com-sdk
- npm.io page: https://npm.io/package/uxuser-sdk

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [crypto](https://npm.io/package/crypto.md) ^1.0.1

## Recent versions

- 1.2.7 (latest) — 2019-09-17
- 1.2.6 — 2019-09-17
- 1.2.5 — 2019-08-07
- 1.2.4 — 2019-08-07
- 1.2.3 — 2019-08-07
- 1.2.2 — 2019-06-03
- 1.2.1 — 2019-04-10
- 1.2.0 — 2019-04-10
- 1.1.0 — 2019-03-18
- 1.0.0 — 2019-01-24

## README

### 一、快速开始
1. 安装
```
npm install cmuser-sdk
```

2. 在cmuser创建AKSK
3. 使用
```
const cmuserSdk = require('cmuser-sdk');
const cmuser = cmuserSdk({ak: ak, sk: sk});
const user = await cmuser.user.create({username:'tuser', pwd: '123456'});
```
参考test.js

### 二、方法参数
* 方法参数及返回值，参考cmuser API

1. cmuserSdk(json) 声名sdk
```
参数，json格式:
ak  必传
sk  必传
host    非必传，可自定义cmuser服务器
```

2. cmuser.user  操作用户类
```
.create(json)    创建用户
.update(json)    修改用户
.delete(user_id) 删除用户
.get(user_id)    用户详情
.query(json)     分页或列表
.rePwd(json)     修改密码
.sendPhone(json)     发送手机验证码
.sendRegeditMail(json)  发送邮件
.verifiedCode(json)     验证邮箱、手机验证码
```

3. cumser.token 操作token类
```
.create(json)  获取token
.check(token)  校验token
.untion(ctx, json)  三方登录。不传ctx直接跳转三方授权页面，传ctx返回要跳转的url。授权成功后跳转到redirect_url参数页面，并返回token（base64编码后的JWT）
```

4. cumser.permission 操作权限类
```
.create(json)    创建权限
.update(json)    修改权限
.delete(permission_id) 删除权限
.get(permission_id)    权限详情
.query(json)     分页或列表
```

5. cumser.role 操作角色类
```
.create(json)    创建角色
.update(json)    修改角色
.delete(role_id) 删除角色
.get(role_id)    权限角色
.query(json)     分页或列表
.getByUser(user_id) 查询用户角色
.addUser(array)  关联用户，格式[{user_id:XXX,role_id:YYY}]
.delUser(array)  取消关联用户，格式[{user_id:XXX,role_id:YYY}]
.addPermission(array)  关联权限，格式[{permission_id:XXX,role_id:YYY}]
.delPermission(array)  取消关联权限，格式[{permission_id:XXX,role_id:YYY}]
```

6. cumser.organization 操作组织类
```
.create(json)    创建组织
.delete(org_id) 删除组织
.query(json)     分页或列表
```

---
_Source: https://npm.io/package/uxuser-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._