@1password/connect 中文文档教程

Question

1Password Connect Node SDK

1Password Connect Node SDK 提供您的 JavaScript & TypeScript 应用程序访问托管在您的基础设施上的 1Password Connect API，并利用 1Password Secrets Automation 的强大功能

该库可由 NodeJS 应用程序、工具使用，以及其他用于访问和管理 1Password Vaults 中项目的自动化。

Installation

您可以使用 npm

npm install @1password/connect

或使用 Yarn

yarn add @1password/connect

Usage

Creating an API client

import { OnePasswordConnect, ItemBuilder } from "@1password/connect";

// Create new connector with HTTP Pooling
const op = OnePasswordConnect({
    serverURL: "http://localhost:8080",
    token: "my-token",
    keepAlive: true,
});

Retrieving Vaults

// Get all vaults
let allVaults = await op.listVaults();

// Get a specific vault
let vault = await op.getVault({vault_id});

Interacting with Items

const myVaultId = {vault_uuid};

// Create an Item
const newItem = new ItemBuilder()
    .setCategory("LOGIN")
    .addField({
        label: "Example",
        value: "MySecret",
        sectionName: "Demo Section",
    })
    .build();

const createdItem = await op.createItem(myVaultId, newItem);

// Get an Item
const item = await op.getItem(myVaultId, {item_uuid});

// Get Item by name
const namedItem = await op.getItemByTitle(myVaultId, "Example Title");

// Update an Item
item.title = "New Title";
const updatedItem = await op.updateItem(myVaultId, myItem);

// Delete an Item
await op.deleteItem(myVaultId, updatedItem.id);

Custom HTTPClient

安装 SDK您可以提供自定义 HTTPClient 类来自定义库向服务器发送请求的方式。

HTTPClient 必须实现 IRequestClient 接口：

import { ClientRequestOptions } from "./client";
interface IRequestClient {
    defaultTimeout: number;

    request(
        method: HTTPMethod,
        url: string,
        opts: ClientRequestOptions,
    ): Promise<Response>;
}

您可以使用自定义客户端：

• handle proxy network access
• add additional logging
• use your own node HTTP request library

Defining ClientRequestOptions

HTTPClient.request(method, url, opts) 方法需要一个选项参数。 下表描述了每个选项：

Option	Description	Required
authToken	The token used to authenticate the client to a 1Password Connect API.	Yes
params	Object with string key-value pairs to be used as querystring parameters	No
data	A string or object made up of key-value pairs. Defines the request body.	No
headers	Object with string key-value pairs. Merged with default headers.	No
timeout	Sets timeout value for the HTTP request.	No

Logging with debug

1Password Connect JS 客户端使用 debug 库来记录运行时信息。

所有日志消息都在 opconnect 命名空间下定义。 要打印日志语句，请在定义 DEBUG 环境变量时包含 opconnect 命名空间：

DEBUG=opconnect:*

Development

Running Tests

来自存储库根目录：

```shell 脚本 制作测试

### Building

shell脚本 建造 ```

---

About 1Password

1Password 是世界上最受欢迎的密码管理器。 通过结合行业领先的安全性和屡获殊荣的设计，该公司为全球企业和消费者提供私密、安全和用户友好的密码管理。 超过 60,000 家企业客户信任 1Password 作为他们的企业密码管理器。

Security

1Password 要求您在发现漏洞时进行负责任的披露。 请通过 BugCrowd 提交发现。

有关安全实践的信息，请访问我们的安全主页。