# @cloudbase/framework-plugin-auth
> 云开发 Tencent CloudBase Framework Auth Plugin 插件，可以一键设置项目下的登录配置。
Latest version **1.9.7** (published 2024-02-03) · Apache-2.0 license · 0 weekly downloads
> **Deprecated.** This package is deprecated.
## Install
```sh
npm install @cloudbase/framework-plugin-auth
pnpm add @cloudbase/framework-plugin-auth
yarn add @cloudbase/framework-plugin-auth
bun add @cloudbase/framework-plugin-auth
```
## Health
**Score 10/100 (F)** — status: deprecated.
Negative: deprecated.
## Facts
| | |
|---|---|
| Version | 1.9.7 |
| Published | 2024-02-03 |
| First published | 2020-09-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1996 |
| Author | Tencent CloudBase Team |
| Maintainers | yuzhen, woodenstone, justan, miusuncle, wangjiachen, wedabot, barretyi, daniel-dx, issacliu, liuyanjie, bobbyzhao, starkwang, yhyang, binggg, fengkx |
## Links
- npm: https://www.npmjs.com/package/@cloudbase/framework-plugin-auth
- Repository: https://github.com/Tencent/cloudbase-framework
- Homepage: https://github.com/Tencent/cloudbase-framework#readme
- Issues: https://github.com/Tencent/cloudbase-framework/issues
- npm.io page: https://npm.io/package/@cloudbase/framework-plugin-auth
## Dependencies (1)
- [@cloudbase/framework-core](https://npm.io/package/@cloudbase/framework-core.md) ^1.9.7
## Recent versions
- 1.9.7 (latest) — 2024-02-03
- 1.8.18-beta.1 (beta) — 2021-12-28
- 1.9.6 — 2022-08-23
- 1.9.5 — 2022-08-22
- 1.9.4 — 2022-06-06
- 1.9.0 — 2021-12-28
- 1.8.16 — 2021-09-10
- 1.8.15 — 2021-09-08
- 1.8.13 — 2021-08-16
- 1.8.12 — 2021-08-16
- 1.8.3 — 2021-07-01
- 1.8.2 — 2021-06-23
- 1.8.1 — 2021-06-18
- 1.8.0 — 2021-06-15
- 1.7.4 — 2021-05-12
- … 63 more at https://npm.io/package/@cloudbase/framework-plugin-auth/versions
## README
# Tencent CloudBase Framework Auth Plugin
[](LICENSE)
[](https://www.npmjs.com/package/@cloudbase/framework-plugin-auth)
[](https://github.com/Tencent/cloudbase-framework/issues)
[](https://github.com/Tencent/cloudbase-framework/pulls)
[](https://github.com/Tencent/cloudbase-framework)
**云开发 CloudBase Framework 框架「登录配置」插件**： 通过云开发 **[CloudBase Framework](https://github.com/Tencent/cloudbase-framework)** 框架一键设置环境下的登录配置。
## 功能特性
- 支持未登录、匿名登录登录设置
- 后续会支持开放平台、公众号、账号密码等其他登录方式配置
## 使用方法
### 步骤一. 准备工作
具体步骤请参照 [准备云开发环境和 CloudBase CLI 命令工具](../../CLI_GUIDE.md)
### 步骤二. 编写 cloudbaserc.json 配置
在 `framework.plugins` 中新增登录插件配置
```json
{
"envId": "YOU_ENV_ID",
"framework": {
"plugins": {
"auth": {
"use": "@cloudbase/framework-plugin-auth",
"inputs": {
"configs": [
{
"platform": "NONLOGIN",
"status": "ENABLE"
}
]
}
}
}
}
}
```
具体配置信息请参考下面的配置文档
### 步骤三. 一键部署
```bash
cloudbase framework deploy
```
## 配置
默认情况下仅需要配置 `appid`、`privateKeyPath` 即可使用，以下配置参数针对有特殊需求的场景
### 配置示例
云开发的配置文件 `cloudbaserc.json`，可在配置文件的 plugins 里修改和写入插件配置
```json
{
"envId": "YOU_ENV_ID",
"framework": {
"plugins": {
"client": {
"use": "@cloudbase/framework-plugin-auth",
"inputs": {
"configs": [
{
"platform": "NONLOGIN",
"status": "ENABLE"
}
]
}
}
}
}
}
```
### 配置参数说明
### `configs`
必填，类型为数组格式 Array.
#### Login 对象
| 属性名称 | 类型 | 长度 | 是否必填 | 描述 |
| -------------- | -------- | ---- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| platform | `String` | 1-32 | 是 | 平台名称，可枚举值：
WECHAT-OPEN：微信开放平台；
WECHAT-PUBLIC：微信公众平台；
QQ-MINI：QQ 小程序；
CUSTOM：自定义登录；
ANONYMOUS：匿名登录；
EMAIL：邮箱登录；
NONLOGIN：未登录
**目前仅支持 ANONYMOUS 和 NONLOGIN** |
| status | `String` | 1-32 | 否 | 默认开启，可枚举值：ENABLE；DISABLE。 |
| platformId | `String` | 1-64 | 否 | 第三方平台的 AppID |
| platformSecret | `String` | 1-64 | 否 | 第三方平台的 AppSecret |
## 更多插件
请访问 [CloudBase Framework 插件列表](https://github.com/Tencent/cloudbase-framework#%E7%9B%AE%E5%89%8D%E6%94%AF%E6%8C%81%E7%9A%84%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8) 搭配使用其他插件
## 文档资料
- 云开发登录鉴权文档：
- 云开发官网地址： [https://cloudbase.net/](https://cloudbase.net/)
- 云开发控制台地址： [https://console.cloud.tencent.com/tcb](https://console.cloud.tencent.com/tcb?tdl_anchor=github&tdl_site=0)
---
_Source: https://npm.io/package/@cloudbase/framework-plugin-auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._