# @easy-cms/auth-oauth 中文文档

规范地址：https://npmcn.com/package/%40easy-cms/auth-oauth/

版本：1\.46\.0
npm 元数据更新时间：2026-11-13T10:41:24.868Z
中文译文更新时间：2026-11-13T03:45:46.701Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40easy-cms/auth-oauth
原文对照：https://npmcn.com/package/%40easy-cms/auth-oauth/?lang=original
项目主页：https://github.com/maritonx/easy-cms#readme
源码仓库：https://github.com/maritonx/easy-cms

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：27.4 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12
- 运行依赖：1 个
- peer 依赖：@easy-cms/core ^1\.46\.0
- 首次发布：2026-10-05T13:53:11.819Z
- 最新版本发布：2026-11-13T10:41:24.527Z
- 近 30 天下载量：12289（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：102（近 12 个月 102 个）

## 中文简介

与 Google 、 微软、 GitHub 或任何 OpenID 连接供应商一起签名到 Easy CMS 管理员

## 安装

```sh
npm install @easy-cms/auth-oauth
```

也可以使用：`pnpm add @easy-cms/auth-oauth`、`yarn add @easy-cms/auth-oauth`、`bun add @easy-cms/auth-oauth`

## README

# @ easy- cms/ auth- oauth

与 Google, 微软( Entra ID), GitHub 或任何 OpenID 连接供应商( Okta, Keycloak, Auth0...) 一起签名到 Easy CMS 管理员. 部分 [简单 CMS](https://github.com/maritonx/easy-cms),用于 Nuxt 和 Next.js 的嵌入式,代码为第一的无头 CMS.

## 安装

```bash
npm install @easy-cms/auth-oauth
```

或者说 `pnpm add`, (中文(简体) ), `yarn add` 或者说 `bun add`。 。 。 .

## 使用量

```ts
import { github, google, microsoft, oidc } from '@easy-cms/auth-oauth'

export default defineConfig({
  // …
  serverURL: 'https://cms.example.com',
  auth: {
    providers: [
      google(), // GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET
      // microsoft(), // MICROSOFT_TENANT_ID, MICROSOFT_CLIENT_ID, MICROSOFT_CLIENT_SECRET
      // github(), // GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET
      // oidc({ id: 'okta', name: 'Okta', issuer: 'https://example.okta.com', clientId, clientSecret }),
    ],
    // allowSignUp: { domains: ['example.com'], role: 'editor' },
  },
})
```

给提供者的重定向(召回) URL 是 `<serverURL>/api/cms/auth/<id>/callback`,比如说. `https://cms.example.com/api/cms/auth/google/callback`。 。 。 .

### 或打开的管理员

`signInPlugin()` 让管理员打开 Google、 Microsoft、 GitHub 和 OpenID 连接供应商在 设置 · 整合 · 签入,在测试签入后; `auth.providers` 保留默认值.

```ts
import { signInPlugin } from '@easy-cms/auth-oauth'

export default defineConfig({
  serverURL: 'https://cms.example.com',
  plugins: [signInPlugin()],
})
```

`npx easy-cms reset-sign-in` 如果管理员不能签名, 则返回到配置的提供者.

## 链接

[单笔签名](https://easycms.dev/docs/sso) • 妇女 [文档](https://easycms.dev/docs) (单位:千美元)[ภาษาไทย](https://easycms.dev/th/docs)· [GitHub 图像](https://github.com/maritonx/easy-cms)

MIT 许可证

## 常见问题

### @easy-cms/auth-oauth 是什么？

与 Google 、 微软、 GitHub 或任何 OpenID 连接供应商一起签名到 Easy CMS 管理员

### 如何安装 @easy-cms/auth-oauth？

在项目目录运行 npm install @easy-cms/auth-oauth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@easy-cms/core（^1\.46\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @easy-cms/auth-oauth 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @easy-cms/auth-oauth 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @easy-cms/auth-oauth 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @easy-cms/auth-oauth 可以商用吗？

@easy-cms/auth-oauth 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @easy-cms/auth-oauth 的下载量有多少？

根据 npm 官方下载统计，@easy-cms/auth-oauth 在 2026/10/13 – 2026/11/11 这 30 天内被下载 12,289 次，日均约 410 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @easy-cms/auth-oauth 还在维护吗？

最新版本 1\.46\.0 发布于 2026/11/13（今天）；至今共发布 102 个版本，其中过去 12 个月发布了 102 个；首次发布于 2026/10/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。