@easy-cms/auth-oauth

中文文档
1.46.0发布于 2026/11/13MITTypeScriptES Module构建来源已验证近 30 天下载 1.2万

Sign in to the Easy CMS admin with Google, Microsoft, GitHub or any OpenID Connect provider

原始使用文档
文档目录4 节
  1. Install
  2. Usage
  3. Or turned on in the admin
  4. Links

@easy-cms/auth-oauth

Sign in to the Easy CMS admin with Google, Microsoft (Entra ID), GitHub or any OpenID Connect provider (Okta, Keycloak, Auth0…). Part of Easy CMS, the embedded, code-first headless CMS for Nuxt and Next.js.

Install

npm install @easy-cms/auth-oauth

Or pnpm add, yarn add or bun add.

Usage

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' },
  },
})

The redirect (callback) URL to give the provider is <serverURL>/api/cms/auth/<id>/callback, e.g. https://cms.example.com/api/cms/auth/google/callback.

Or turned on in the admin

signInPlugin() lets admins turn Google, Microsoft, GitHub and OpenID Connect providers on in Settings → Integrations → Sign-in, after a test sign-in; auth.providers stay the default.

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

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

npx easy-cms reset-sign-in goes back to the config's providers if admins can't sign in.

Single sign-on · Documentation (ภาษาไทย) · GitHub

MIT License

版本与发布记录

@easy-cms/auth-oauth 共发布 102 个版本,首次发布于 2026/10/05;过去 12 个月发布了 102 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.46.0latest2026/11/13今天
1.45.02026/11/13今天
1.44.02026/11/13今天
1.43.12026/11/121 天前
1.43.02026/11/121 天前
1.42.12026/11/103 天前

其他发布通道:rc → 1.0.0-rc.0。

关于 @easy-cms/auth-oauth 的常见问题

@easy-cms/auth-oauth 是什么?

Sign in to the Easy CMS admin with Google, Microsoft, GitHub or any OpenID Connect provider

如何安装 @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 和提交记录判断。