# @agentmail/agentid-better-auth 中文文档

规范地址：https://npmcn.com/package/%40agentmail/agentid-better-auth/

版本：0\.1\.1
npm 元数据更新时间：2026-09-29T22:59:24.621Z
中文译文更新时间：2026-11-06T04:34:45.019Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40agentmail/agentid-better-auth
原文对照：https://npmcn.com/package/%40agentmail/agentid-better-auth/?lang=original
项目主页：https://www.agentid.com/docs/better-auth
源码仓库：https://github.com/agentmail-to/agentid-better-auth

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

- 包体积（解压后）：10.7 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：better-auth \>=1\.7\.2 \<2
- 首次发布：2026-09-01T20:09:03.890Z
- 最新版本发布：2026-09-02T22:39:25.511Z
- 近 30 天下载量：5069（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

Better Auth 通用 OAuth 插件的代理ID 提供者助手

## 安装

```sh
npm install @agentmail/agentid-better-auth
```

也可以使用：`pnpm add @agentmail/agentid-better-auth`、`yarn add @agentmail/agentid-better-auth`、`bun add @agentmail/agentid-better-auth`

## README

# 为更好的 Auth 代理ID

`@agentmail/agentid-better-auth` 是 AgentID 提供者帮助更好 Auth 通用 OAuth 插件 。 它让AI特工和他们的特工Mail签约 身份,而Better Auth处理 OAuth 回调和会话.

## 所需资源

-   较好的Auth 1.7.2 或以后
-   来自代理ID客户端 [代理ID控制台](https://console.agentid.com/)

## 安装

```sh
pnpm add @agentmail/agentid-better-auth
```

## 配置

在 AgentID 控制台中注册此回调 URL :

```text
https://yourapp.com/api/auth/callback/agentid
```

然后将援助者添加到更好的Auth中:

```ts
import { agentid } from "@agentmail/agentid-better-auth";
import { betterAuth } from "better-auth";
import { genericOAuth } from "better-auth/plugins";

export const auth = betterAuth({
    plugins: [
        genericOAuth({
            config: [
                agentid({
                    clientId: process.env.AGENTID_CLIENT_ID!,
                    clientSecret: process.env.AGENTID_CLIENT_SECRET!,
                }),
            ],
        }),
    ],
});
```

使用您已有的更好的 Auth 客户端, 或者创建一个 。 没有客户端插件 要求:

```ts
import { createAuthClient } from "better-auth/react";

export const authClient = createAuthClient();
```

以标准社会提供者 API 开始登录 :

```ts
await authClient.signIn.social({
    provider: "agentid",
    callbackURL: "/",
});
```

见 [代理ID 更好的认证指南](https://www.agentid.com/docs/better-auth) 完全设置.

## 范围和所有人索赔

默认范围是 `openid`, (中文(简体) ), `email`,以及 `profile`。这些识别 特工 并披露其特工地址 还要求提供下列资料: 拥有代理人的人,加上 `owner_profile` 财务报告和审定财务报表 `owner_email`数字 :

```ts
agentid({
    clientId: process.env.AGENTID_CLIENT_ID!,
    clientSecret: process.env.AGENTID_CLIENT_SECRET!,
    scopes: ["openid", "email", "profile", "owner_profile", "owner_email"],
});
```

AgentID的UserInfo端点归还所有者索赔,可供 原始 OAuth 配置中更好的 Auth 回调 。 ưμ㼯A 稍后用存储的访问符读取它们的例子 .

## 礼宾细节

-   发现 : `https://auth.agentid.com/.well-known/openid-configuration`
-   Token 端点认证 : `client_secret_basic`
-   PKCE: 所需(`S256`(中文(简体) )
-   回调路径 : `/api/auth/callback/agentid`
-   ID符:通过AgentID的发现元数据和JWKS验证

AgentID 在授权码ID代号中不响应 OIDC 非 。 帮手 因此禁用 Better Auth 对该供应商的非ce 约束,并要求 换成PKCE 签名、发行人、受众、算法和过期验证 继续启用.

## 发展

```sh
pnpm install
pnpm check
```

## 常见问题

### @agentmail/agentid-better-auth 是什么？

Better Auth 通用 OAuth 插件的代理ID 提供者助手

### 如何安装 @agentmail/agentid-better-auth？

在项目目录运行 npm install @agentmail/agentid-better-auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：better-auth（\>=1\.7\.2 \<2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @agentmail/agentid-better-auth 支持 TypeScript 吗？

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

### @agentmail/agentid-better-auth 支持 ESM 还是 CommonJS？

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

### @agentmail/agentid-better-auth 可以商用吗？

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

### @agentmail/agentid-better-auth 的下载量有多少？

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

### @agentmail/agentid-better-auth 还在维护吗？

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