# @dbx-tools/auth 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/auth/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:18:43.796Z
中文译文更新时间：2026-11-11T17:19:51.112Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：350 kB，49 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-08-07T19:28:05.547Z
- 最新版本发布：2026-11-10T19:18:43.455Z
- 近 30 天下载量：12616（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：168（近 12 个月 168 个）

## 中文简介

Databricks 剖面解析度和Node.js 和 Bun 的符号或认证标题

## 安装

```sh
npm install @dbx-tools/auth
```

也可以使用：`pnpm add @dbx-tools/auth`、`yarn add @dbx-tools/auth`、`bun add @dbx-tools/auth`

## README

# @dbx-tools/ auth (英语)

解析 Databricks 配置文件,并从中生成符号或认证信头 节点J和邦。 软件包选择个人访问符 (PAT), 机器对机器 (M2M), CLI 用户对机(U2M), Databricks App 服务-主机, 或 App 半用户(OBO)认证和协调 进程内存.

## 快开始

```ts
import { client } from "@dbx-tools/auth";

const auth = await client.createAuthClient();
const headers = await auth.headers();
await fetch(`${auth.host}/api/2.0/clusters/list`, { headers });
```

没有选择, `createAuthClient()` 解决标准 `DATABRICKS_*` 环境值和配置的默认配置。 明确选项 覆盖这些默认来源 .

## 认证路径

-   标准 `.databrickscfg` 解析和默认配置选择 .
-   无密配置配置配置目录 .
-   CLI支持的U2M令牌和登录命令.
-   Direct PAT, M2M, App Services-Principal, 以及请求范围 App OBO 令牌.
-   空绑定选项的自动 Python SDK 运行时认证 .
-   检查- 锁定- 重新检查令牌的获取和明确令牌刷新 .
-   可用时带有已解析工作空间ID的认证信头 .
-   没有 JavaScript SDK 、 通用的 HTTP 客户端、 可执行安装器或持久性 符号缓存.

CLI 支持的 U2M 需要一个可用的 `databricks` 可执行文件或明示文件 `DATABRICKS_CLI_PATH`。Databricks CLI 仍然负责自己的登录 和证书的坚持.

## 客户端 API

```ts
import { client, profile } from "@dbx-tools/auth";

const auth = await client.createAuthClient();
const token = await auth.token();
const headers = await auth.headers();
const host = auth.host;
const profiles = profile.listProfiles();
```

`headers()` 返回授权标题,并 `x-databricks-workspace-id` 当所选配置文件有工作空间ID时。 过 `{ login: false }` 以标记或认证获取以禁用 互动登录. 过 `{ refresh: true }` 以绕过可重用缓存符号.

当此软件包运行于一个 Databricks 中生成的 Python 绑定时 笔记本或工作, `createAuthClient()` 不使用配置文件或证书选项 python SDK 的默认值 `WorkspaceClient`。明确的备选方案继续通过 普通配置、 PAT、 M2M、 CLI 或 App 路径.

浏览器和 UI 代码应导入认证类型值、目标值、配置文件 摘要、配置选择和客户端配置计划 `@dbx-tools/shared-auth`。 。 。 .

## 在客户端中使用证书

使用返回的内容 `AuthClient` 直接 :

```ts
const auth = await client.createAuthClient({ profile: "DEFAULT" });
const headers = await auth.headers();
```

在 HTTP 请求中使用信头, 或者在 AppKit 中注入符和主机 或者Databricks SDK工作空间客户端.

此软件包认证出局 Databricks 调用 。 它不能保护一个 HTTP路线或公共地道. 使用 [@dbx-tools/隧道](https://npmcn.com/package/%40dbx-tools/tunnel) 联合国 应用程序访问者需要访问控制时无密码闸.

## 公共模块

-   `client` 出口 `createAuthClient`, (中文(简体) ), `AuthClient`,访问结果,以及 符号生命周期操作.
-   `config` 出口含有秘密的剖面图选项、寿命周期时间和 头名.
-   `profile` 出口概况解析和上市业务.

提供商,锁,和信使存储内部不属于公共API.

## 调试日志

设定 `LOG_LEVEL=debug` 以追踪配置选择、提供者选择、证书 锁,缓存再利用, 令牌刷新, 和登录回落。 日志从不包含访问 符号、刷新符号、客户秘密、授权值、原始请求 头,或要求尸体.

## 常见问题

### @dbx-tools/auth 是什么？

Databricks 剖面解析度和Node\.js 和 Bun 的符号或认证标题

### 如何安装 @dbx-tools/auth？

在项目目录运行 npm install @dbx-tools/auth，或使用 pnpm add / yarn add / bun add。

### @dbx-tools/auth 支持 TypeScript 吗？

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

### @dbx-tools/auth 支持 ESM 还是 CommonJS？

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

### @dbx-tools/auth 可以商用吗？

@dbx-tools/auth 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/auth 的下载量有多少？

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

### @dbx-tools/auth 还在维护吗？

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