@dbx-tools/ auth (英语)
解析 Databricks 配置文件,并从中生成符号或认证信头 节点J和邦。 软件包选择个人访问符 (PAT), 机器对机器 (M2M), CLI 用户对机(U2M), Databricks App 服务-主机, 或 App 半用户(OBO)认证和协调 进程内存.
快开始
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
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 直接 :
const auth = await client.createAuthClient({ profile: "DEFAULT" });
const headers = await auth.headers();
在 HTTP 请求中使用信头, 或者在 AppKit 中注入符和主机 或者Databricks SDK工作空间客户端.
此软件包认证出局 Databricks 调用 。 它不能保护一个 HTTP路线或公共地道. 使用 @dbx-tools/隧道 联合国 应用程序访问者需要访问控制时无密码闸.
公共模块
client出口createAuthClient, (中文(简体) ),AuthClient,访问结果,以及 符号生命周期操作.config出口含有秘密的剖面图选项、寿命周期时间和 头名.profile出口概况解析和上市业务.
提供商,锁,和信使存储内部不属于公共API.
调试日志
设定 LOG_LEVEL=debug 以追踪配置选择、提供者选择、证书
锁,缓存再利用, 令牌刷新, 和登录回落。 日志从不包含访问
符号、刷新符号、客户秘密、授权值、原始请求
头,或要求尸体.