> For the complete documentation index, see [llms.txt](https://manual.dxable.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.dxable.com/1password/1password-connect-server-api-reference.md).

# 1Password Connect Server APIリファレンス

ℹ️情報\
1Password Secrets Automation と 1Password Connect Server を初めて使う場合は、[Secrets Automationワークフローの開始方法を学習してください](https://developer.1password.com/docs/connect/get-started/)。

Connect APIを使うと、アカウント内の保管庫やアイテムを操Createしたり、Connectサーバー上の APIアクティビティーを一覧表示したりできます。

リクエストヘッダー

保管庫をリストする​

保管庫の詳細を取得する​

アイテムをリストする

アイテムを追加する​

アイテムの詳細を取得する​

アイテムを置き換える​

アイテムを削除する

アイテム属性のサブセットを更新する

ファイルをリストする​

ファイルの詳細を取得する​

ファイルの内容を取得する​

APIアクティビティーをリストする​

サーバーのハートビートチェック​

サーバーのヘルスチェック​

メトリクスを取得する

レスポンスオブジェクトモデル​

別のツールでAPIを表示するには、API仕様ファイル：[1password-connect-api.yaml](https://i.1password.com/media/1password-connect/1password-connect-api.yaml)をダウンロードしてください。

### **リクエストヘッダー** <a href="#id-51a1ff3353z6" id="id-51a1ff3353z6"></a>

APIへの各リクエストは[アクセストークン](https://developer.1password.com/docs/connect/manage-connect/#manage-access-tokens)で認証される必要があります。それを提供し、コンテンツ タイプを指定します。

Authorization: Bearer \<access\_token>\
Content-type: application/json

### 保管庫**をリストする**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#list-vaults) <a href="#qvv5wvj0nj8p" id="qvv5wvj0nj8p"></a>

GET /v1/vaults

#### **Pathパラメーター** <a href="#id-6theedmqkiaj" id="id-6theedmqkiaj"></a>

Pathパラメーターはありません。

#### **Queryパラメーター** <a href="#id-41dtcjm5yvfk" id="id-41dtcjm5yvfk"></a>

| **パラメーター** | **タイプ** | **詳細**                                                                                                                                                                                                                                    |
| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **filter** | string  | <p>Filter the vault collection using <a href="https://bookstack.soffid.com/books/scim/page/scim-query-syntax">SCIM-style filters</a>. Vaults can only be filtered by name. <em>Optional.</em></p><p>For example: name eq "Demo Vault"</p> |

#### **レスポンス** <a href="#cs556q5w6qnz" id="cs556q5w6qnz"></a>

200

Returns an array of vault names and IDs

401

Invalid or missing token

### 保管庫**の詳細を取得する**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#get-vault-details) <a href="#urfgfrd96mnk" id="urfgfrd96mnk"></a>

GET /v1/vaults/{vaultUUID}

#### **Pathパラメーター** <a href="#oco31t7jgnrx" id="oco31t7jgnrx"></a>

| **パラメーター**    | **タイプ** | **詳細**                                        |
| ------------- | ------- | --------------------------------------------- |
| **vaultUUID** | string  | The UUID of the vault to retrieve items from. |

#### **Queryパラメーター** <a href="#kdo76fm6utgf" id="kdo76fm6utgf"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#id-88vfxmqxu76g" id="id-88vfxmqxu76g"></a>

200

Returns a [Vault object](https://developer.1password.com/docs/connect/connect-api-reference/#vault-object)

401

Invalid or missing token

403

Unauthorized access

404

Vault not found

### **アイテムをリストする** <a href="#id-2rdl0mw2xcz" id="id-2rdl0mw2xcz"></a>

GET /v1/vaults/{vaultUUID}/items

#### **Pathパラメーター** <a href="#msk165ho3p0q" id="msk165ho3p0q"></a>

| **パラメーター**    | **タイプ** | **詳細**                                       |
| ------------- | ------- | -------------------------------------------- |
| **vaultUUID** | string  | The UUID of the vault to get the details of. |

#### **Queryパラメーター** <a href="#t2npzq4o192s" id="t2npzq4o192s"></a>

| **パラメーター** | **タイプ** | **詳細**                                                                                                                                                                                                                                                                  |
| ---------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **filter** | string  | <p>Filter the item collection using <a href="https://bookstack.soffid.com/books/scim/page/scim-query-syntax">SCIM-style filters </a>. Items can only be filtered by title or tag. <em>Optional.</em></p><p>For example: title eq "Example Item" or tag eq "banking"</p> |

#### **レスポンス** <a href="#yb0r4rip3w8f" id="yb0r4rip3w8f"></a>

200

Returns an array of [Item objects](https://developer.1password.com/docs/connect/connect-api-reference/#item-object) that don't include sections and fields

401

Invalid or missing token

404

Vault not found

### **アイテムを追加する**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#add-an-item) <a href="#id-49apmbqfqsd" id="id-49apmbqfqsd"></a>

POST /v1/vaults/{vaultUUID}/items

このリクエストには、アイテムをCreateするための情報を含むFullItemオブジェクトが含まれている必要があります。

例：

{

"vault": {

"id": "ftz4pm2xxwmwrsd7rjqn7grzfz"

},

"title": "Secrets Automation Item",

"category": "LOGIN",

"tags": \[

"connect",

"\ud83d\udc27"

],

"sections": \[

{

"label": "Security Questions",

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

}

],

"fields": \[

{

"value": "wendy",

"purpose": "USERNAME"

},

{

"purpose": "PASSWORD",

"generate": true,

"recipe":

{

"length": 55,

"characterSets": \[

"LETTERS",

"DIGITS"

]

}

},

{

"section": {

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

},

"type": "CONCEALED",

"generate": true,

"label": "Recovery Key"

},

{

"section": {

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

},

"type": "STRING",

"generate": true,

"label": "Random Text"

},

{

"type": "URL",

"label": "Example",

"value": "<https://example.com>"

}

]

}

| **パラメーター**   | **タイプ** | **詳細**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **title**    | string  | The title of the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **vault**    | object  | An object containing an id property whose value is the UUID of the vault the item is in.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| **category** | string  | <p>The category of the item. One of:</p><ul><li>"LOGIN"</li><li>"PASSWORD"</li><li>"API\_CREDENTIAL"</li><li>"SERVER"</li><li>"DATABASE"</li><li>"CREDIT\_CARD"</li><li>"MEMBERSHIP"</li><li>"PASSPORT"</li><li>"SOFTWARE\_LICENSE"</li><li>"OUTDOOR\_LICENSE"</li><li>"SECURE\_NOTE"</li><li>"WIRELESS\_ROUTER"</li><li>"BANK\_ACCOUNT"</li><li>"DRIVER\_LICENSE"</li><li>"IDENTITY"</li><li>"REWARD\_PROGRAM"</li><li>"EMAIL\_ACCOUNT"</li><li>"SOCIAL\_SECURITY\_NUMBER"</li><li>"MEDICAL\_RECORD"</li><li>"SSH\_KEY"</li></ul><p>You can't create items using the "CUSTOM" or "DOCUMENT" categories.</p> |
| **urls**     | array   | Array of [URL objects](https://developer.1password.com/docs/connect/connect-api-reference/#item-url-object) containing URLs for the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| **favorite** | boolean | Mark the item as a favorite.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **tags**     | string  | An array of strings of the tags assigned to the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **fields**   | array   | An array of [Field objects](https://developer.1password.com/docs/connect/connect-api-reference/#item-field-object) of the fields to include with the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| **sections** | array   | An array of [Section objects](https://developer.1password.com/docs/connect/connect-api-reference/#item-section-object) of the sections to include with the item.                                                                                                                                                                                                                                                                                                                                                                                                                                             |

#### **Pathパラメーター** <a href="#ku45bzs3x49o" id="ku45bzs3x49o"></a>

| **パラメーター**    | **タイプ** | **詳細**                                      |
| ------------- | ------- | ------------------------------------------- |
| **vaultUUID** | string  | The UUID of the vault to create an item in. |

#### **Queryパラメーター** <a href="#pra8xlachn8h" id="pra8xlachn8h"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#id-27nusgrhjoey" id="id-27nusgrhjoey"></a>

200

Returns [Item object](https://developer.1password.com/docs/connect/connect-api-reference/#item-object) containing the new item

400

Unable to create item due to invalid input

401

Invalid or missing token

403

Unauthorized access

404

Item not found

### **アイテムの詳細を取得する**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#get-item-details) <a href="#d0lih4izqvgp" id="d0lih4izqvgp"></a>

GET /v1/vaults/{vaultUUID}/items/{itemUUID}

#### **Pathパラメーター** <a href="#aqdkucwgc73r" id="aqdkucwgc73r"></a>

| **パラメーター**    | **タイプ** | **詳細**                                           |
| ------------- | ------- | ------------------------------------------------ |
| **vaultUUID** | string  | The UUID of the vault to retrieve the item from. |
| **itemUUID**  | string  | The UUID of the item to retrieve.                |

#### **Queryパラメーター** <a href="#gs1z0g5ukw2u" id="gs1z0g5ukw2u"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#mnp6stymkywe" id="mnp6stymkywe"></a>

200

Returns an [Item object](https://developer.1password.com/docs/connect/connect-api-reference/#item-object)

401

Invalid or missing token

403

Unauthorized access

404

Item not found

### **アイテムを置き換える**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#replace-an-item) <a href="#id-3brgnlrrst88" id="id-3brgnlrrst88"></a>

PUT /v1/vaults/{vaultUUID}/items/{itemUUID}

#### **Pathパラメーター** <a href="#id-4ms1b6j0du4f" id="id-4ms1b6j0du4f"></a>

| **パラメーター**    | **タイプ** | **詳細**                                           |
| ------------- | ------- | ------------------------------------------------ |
| **vaultUUID** | string  | The UUID of the vault to retrieve the item from. |
| **itemUUID**  | string  | The UUID of the item to replace.                 |

#### **Queryパラメーター** <a href="#aoza2hgk0g29" id="aoza2hgk0g29"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#hgjeoria4ciy" id="hgjeoria4ciy"></a>

200

Returns an [Item object](https://developer.1password.com/docs/connect/connect-api-reference/#item-object)

400

Unable to create item due to invalid input

401

Invalid or missing token

403

Unauthorized access

404

Item not found

### **アイテムを削除する** <a href="#ojx2xeipmssx" id="ojx2xeipmssx"></a>

DELETE /v1/vaults/{vaultUUID}/items/{itemUUID}

#### **Pathパラメーター** <a href="#abuj34vjmll6" id="abuj34vjmll6"></a>

| **パラメーター**    | **タイプ** | **詳細**                                           |
| ------------- | ------- | ------------------------------------------------ |
| **vaultUUID** | string  | The UUID of the vault to retrieve the item from. |
| **itemUUID**  | string  | The UUID of the item to delete.                  |

#### **Queryパラメーター** <a href="#id-17kv7hywxi47" id="id-17kv7hywxi47"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#huexprly6876" id="huexprly6876"></a>

204

Successfully deleted an item

401

Invalid or missing token

403

Unauthorized access

404

Item not found

### **アイテム属性のサブセットを更新する** <a href="#j433kbxeinm7" id="j433kbxeinm7"></a>

PATCH /v1/vaults/{vaultUUID}/items/{itemUUID}\
アイテムまたはアイテムのフィールドに追加、削除、または置換操Createを適用します。[RFC6902 JSON Patch](https://tools.ietf.org/html/rfc6902)ドキュメント標準を使用します。

| **パラメーター** | **タイプ** | **詳細**                                                                                                                                                     |
| ---------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **op**     | string  | <p>The kind of operation to perform. One of:</p><ul><li>add</li><li>remove</li><li>replace</li></ul>                                                       |
| **path**   | string  | An RFC6901 JSON Pointer to the item, an item attribute, an item field by field ID, or an item field attribute. For example: "/fields/vy09gd8EXAMPLE/label" |
| **value**  | any     | The new value to apply at the path.                                                                                                                        |

#### **Pathパラメーター** <a href="#ng6gqqhyw7s3" id="ng6gqqhyw7s3"></a>

| **パラメーター**    | **タイプ** | **詳細**                                |
| ------------- | ------- | ------------------------------------- |
| **vaultUUID** | string  | The UUID of the vault the item is in. |
| **itemUUID**  | string  | The UUID of the item to update.       |

#### **Queryパラメーター** <a href="#jb251b596aji" id="jb251b596aji"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#id-290liav06exn" id="id-290liav06exn"></a>

200

Returns an [Item object](https://developer.1password.com/docs/connect/connect-api-reference/#item-object) of the updated item.

401

Invalid or missing token

403

Unauthorized access

404

Item not found

### **ファイルをリストする**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#list-files) <a href="#prd5wqdu7zef" id="prd5wqdu7zef"></a>

GET /v1/vaults/{vaultUUID}/items/{itemUUID}/files

#### **Pathパラメーター** <a href="#jlhiq3r691we" id="jlhiq3r691we"></a>

| **パラメーター**    | **タイプ** | **詳細**                                       |
| ------------- | ------- | -------------------------------------------- |
| **vaultUUID** | string  | The UUID of the vault to get the details of. |
| **itemUUID**  | string  | The UUID of the item to retrieve.            |

#### **Queryパラメーター** <a href="#iz8p0aiyz0om" id="iz8p0aiyz0om"></a>

| **パラメーター**          | **タイプ** | **詳細**                                                                                                                                                                            |
| ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **inline\_content** | boolean | Whether to return the Base-64 encoded file content. The file size must be less than OP\_MAX\_INLINE\_FILE\_SIZE\_KB, or 100 kilobytes if the file size isn't defined. *Optional.* |

#### **レスポンス** <a href="#iymdw49cjws4" id="iymdw49cjws4"></a>

200

Returns an array of [File objects](https://developer.1password.com/docs/connect/connect-api-reference/#item-file-object)

401

Invalid or missing token

404

Item not found

413

File too large to display inline

### **ファイルの詳細を取得する**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#get-file-details) <a href="#lq1fkb8x1jza" id="lq1fkb8x1jza"></a>

GET /v1/vaults/{vaultUUID}/items/{itemUUID}/files/{fileUUID}

#### **Pathパラメーター** <a href="#t6g5lenkoxue" id="t6g5lenkoxue"></a>

| **パラメーター**    | **タイプ** | **詳細**                                           |
| ------------- | ------- | ------------------------------------------------ |
| **vaultUUID** | string  | The UUID of the vault to retrieve the item from. |
| **itemUUID**  | string  | The UUID of the item to retrieve the file from.  |
| **fileUUID**  | string  | The UUID of the file to retrieve.                |

#### **Queryパラメーター** <a href="#nj45b79gdm7t" id="nj45b79gdm7t"></a>

| **パラメーター**          | **タイプ** | **詳細**                                                                                                                                                                            |
| ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **inline\_content** | boolean | Whether to return the Base-64 encoded file content. The file size must be less than OP\_MAX\_INLINE\_FILE\_SIZE\_KB, or 100 kilobytes if the file size isn't defined. *Optional.* |

#### **レスポンス** <a href="#wnuhju2vhr9h" id="wnuhju2vhr9h"></a>

200

Returns a [File object](https://developer.1password.com/docs/connect/connect-api-reference/#item-file-object)

401

Invalid or missing token

403

Unauthorized access

404

File not found

413

File too large to display inline

### **ファイルの内容を取得する**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#get-file-content) <a href="#jfe1bjtk7quq" id="jfe1bjtk7quq"></a>

GET /v1/vaults/{vaultUUID}/items/{itemUUID}/files/{fileUUID}/content

#### **Pathパラメーター** <a href="#b3n0b94s39h" id="b3n0b94s39h"></a>

| **パラメーター**    | **タイプ** | **詳細**                                           |
| ------------- | ------- | ------------------------------------------------ |
| **vaultUUID** | string  | The UUID of the vault to retrieve the item from. |
| **itemUUID**  | string  | The UUID of the item to retrieve the file from.  |
| **fileUUID**  | string  | The UUID of the file to retrieve.                |

#### **Queryパラメーター** <a href="#id-9lsyfd1pi9fu" id="id-9lsyfd1pi9fu"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#csybm1a3t6aj" id="csybm1a3t6aj"></a>

200

Returns the content of the file

401

Invalid or missing token

403

Unauthorized access

404

File not found

### **APIアクティビティーをリストする**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#list-api-activity) <a href="#giyc738dvrpj" id="giyc738dvrpj"></a>

GET /v1/activity

行われたAPIリクエストのリストを取得します。

#### **Queryパラメーター** <a href="#oncgpylqi39w" id="oncgpylqi39w"></a>

| **パラメーター** | **タイプ** | **詳細**                                                                           |
| ---------- | ------- | -------------------------------------------------------------------------------- |
| **limit**  | integer | How many API Events should be retrieved in a single request. *Optional.*         |
| **offset** | integer | How far into the collection of API Events should the response start. *Optional.* |

### **サーバーのハートビートチェック**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#server-heartbeat) <a href="#r2pbcild27cx" id="r2pbcild27cx"></a>

GET /heartbeat.

サーバーがアクティブかどうかを確認するためエンドポイントに単純な「ping」を送ります。

#### **Queryパラメーター** <a href="#irn1j5v6zegm" id="irn1j5v6zegm"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#vzt4t9upbqh" id="vzt4t9upbqh"></a>

200

Returns a text/plain response with a single "."

### **サーバーのヘルスチェック**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#server-health) <a href="#us9uio5rb9oa" id="us9uio5rb9oa"></a>

GET /health

サーバーとそのサービスの依［Save］関係の状態を問い合わせます。

#### **Queryパラメーター** <a href="#jsk10mj94d2f" id="jsk10mj94d2f"></a>

Queryパラメーターはありません。.

#### **レスポンス** <a href="#id-3rqngjl44l4z" id="id-3rqngjl44l4z"></a>

200

Returns a [Server Health object](https://developer.1password.com/docs/connect/connect-api-reference/#server-health-object)

### **メトリクスを取得する** <a href="#a3r4475o4q9f" id="a3r4475o4q9f"></a>

GET /metrics

\
サーバーによって収集されたPrometheusメトリックを返します。

#### **Queryパラメーター** <a href="#eakrx7l3nufv" id="eakrx7l3nufv"></a>

#### Queryパラメーターはありません。. <a href="#id-9v3kgdcmxgr5" id="id-9v3kgdcmxgr5"></a>

#### **レスポンス** <a href="#sqqve4sf7pg7" id="sqqve4sf7pg7"></a>

200

Prometheusメトリックのプレーンテキストのリストを返します。詳細については、 [Prometheusのドキュメント](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format)を参照してください。

### **レスポンスオブジェクトモデル**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#response-object-models) <a href="#id-79orcbyu4jri" id="id-79orcbyu4jri"></a>

#### **APIRequestオブジェクト**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#apirequest-object) <a href="#i5yvptxhnmv9" id="i5yvptxhnmv9"></a>

| **パラメーター**    | **タイプ**  | **詳細**                                                                                                               |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| **requestID** | string   | The UUID for the request.                                                                                            |
| **timestamp** | dateTime | Date and time of the request.                                                                                        |
| **action**    | string   | <p>The action taken. One of:</p><ul><li>"READ"</li><li>"CREATE"</li><li>"UPDATE"</li><li>"DELETE"</li></ul>          |
| **result**    | string   | <p>The result of the action. One of:</p><ul><li>"SUCCESS"</li><li>"DENY"</li></ul>                                   |
| **actor**     | object   | An [Actor object](https://developer.1password.com/docs/connect/connect-api-reference/#apirequest-actor-object).      |
| **resource**  | object   | A [Resource object](https://developer.1password.com/docs/connect/connect-api-reference/#apirequest-resource-object). |

**APIRequest: Actorオブジェクト**

| **パラメーター**    | **タイプ** | **詳細**                                                         |
| ------------- | ------- | -------------------------------------------------------------- |
| **id**        | string  | The UUID of the Connect server that made the request.          |
| **account**   | string  | The UUID of the 1Password account the request went to.         |
| **jti**       | string  | The UUID of the access token used to authenticate the request. |
| **userAgent** | string  | The user agent string specified in the request.                |
| **ip**        | string  | The IP address the request originated from.                    |

**APIRequest: Resourceオブジェクト**

| **パラメーター**      | **タイプ** | **詳細**                                                                                 |
| --------------- | ------- | -------------------------------------------------------------------------------------- |
| **type**        | string  | <p>The resource requested. One of:</p><ul><li>"ITEM"</li><li>"VAULT"</li></ul>         |
| **vault**       | object  | An object containing an id property with the value of the UUID of the vault requested. |
| **item**        | object  | An object containing an id property with the value of the UUID of the item requested.  |
| **itemVersion** | integer | The version of the item.                                                               |

#### **ErrorResponseオブジェクト**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#errorresponse-object) <a href="#oohxl6e1clp4" id="oohxl6e1clp4"></a>

{

status: 401,

message: "Invalid or missing token"

}

| **パラメーター**  | **タイプ** | **詳細**                         |
| ----------- | ------- | ------------------------------ |
| **status**  | integer | The HTTP status code.          |
| **message** | string  | A message detailing the error. |

#### **Vaultオブジェクト** <a href="#yxj14jv5ustb" id="yxj14jv5ustb"></a>

{

"id": "ytrfte14kw1uex5txaore1emkz",

"name": "Demo",

"attributeVersion": 1,

"contentVersion": 72,

"items": 7,

"type": "USER\_CREATED",

"createdAt": "2021-04-10T17:34:26Z",

"updatedAt": "2021-04-13T14:33:50Z"

}

| **パラメーター**           | **タイプ**  | **詳細**                                                                                                                                                                                                  |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id**               | string   | The UUID of the vault.                                                                                                                                                                                  |
| **name**             | string   | The name of the vault.                                                                                                                                                                                  |
| **description**      | string   | The description for the vault.                                                                                                                                                                          |
| **attributeVersion** | integer  | The version of the vault metadata.                                                                                                                                                                      |
| **contentVersion**   | integer  | The version of the vault contents.                                                                                                                                                                      |
| **items**            | integer  | Number of active items in the vault.                                                                                                                                                                    |
| **type**             | string   | <p>The type of vault. One of:</p><ul><li>"EVERYONE": The team Shared vault.</li><li>"PERSONAL": The Private vault for the Connect server.</li><li>"USER\_CREATED": A vault created by a user.</li></ul> |
| **createdAt**        | dateTime | Date and time when the vault was created.                                                                                                                                                               |
| **updatedAt**        | dateTime | Date and time when the vault or its contents were last changed.                                                                                                                                         |

#### **Itemオブジェクト**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#item-object) <a href="#id-9aytljz2d75j" id="id-9aytljz2d75j"></a>

{

"tags": \[

"connect",

"\ud83d\udc27"

],

"vault": {

"id": "ftz4pm2xxwmwrsd7rjqn7grzfz"

},

"category": "LOGIN",

"sections": \[

{

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562",

"label": "Security Questions"

}

],

"fields": \[

{

"id": "username",

"type": "STRING",

"purpose": "USERNAME",

"label": "username",

"value": "wendy"

},

{

"id": "password",

"type": "CONCEALED",

"purpose": "PASSWORD",

"label": "password",

"value": "hLDegPkuMQqyQiyDZqRdWGoojiN5KYQtXuA0wBDe9z3Caj6FQGHpbGu",

"entropy": 189.78359985351562

},

{

"id": "notesPlain",

"type": "STRING",

"purpose": "NOTES",

"label": "notesPlain"

},

{

"id": "a6cvmeqakbxoflkgmor4haji7y",

"type": "URL",

"label": "Example",

"value": "<https://example.com>"

},

{

"id": "boot3vsxwhuht6g7cmcx4m6rcm",

"section": {

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

},

"type": "CONCEALED",

"label": "Recovery Key",

"value": "s=^J\@GhHP\_isYP>LCq?vv8u7T:\*wBP.c"

},

{

"id": "axwtgyjrvwfp5ij7mtkw2zvijy",

"section": {

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

},

"type": "STRING",

"label": "Random Text",

"value": "R)D\~KZdV!8?51QoCibDUse7=n\@wKR\_}]"

}

],

"files": \[

{

"id": "6r65pjq33banznomn7q22sj44e",

"name": "testfile.txt",

"size": 35,

"content\_path": "v1/vaults/ftz4pm2xxwmwrsd7rjqn7grzfz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/6r65pjq33banznomn7q22sj44e/content",

},

{

"id": "oyez5gf6xjfptlhc3o4n6o6hvm",

"name": "samplefile.png",

"size": 296639,

"content\_path": "v1/vaults/ftz4pm2xxwmwrsd7rjqn7grzfz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/oyez5gf6xjfptlhc3o4n6o6hvm/content",

}

],

"createdAt": "2021-04-10T17:20:05.98944527Z",

"updatedAt": "2021-04-13T17:20:05.989445411Z"

}

| **パラメーター**       | **タイプ**  | **詳細**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id**           | string   | The UUID of the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **title**        | string   | The title of the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **vault**        | object   | An object containing an id property whose value is the UUID of the vault the item is in.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **category**     | string   | <p>The category of the item. One of:</p><ul><li>"LOGIN"</li><li>"PASSWORD"</li><li>"API\_CREDENTIAL"</li><li>"SERVER"</li><li>"DATABASE"</li><li>"CREDIT\_CARD"</li><li>"MEMBERSHIP"</li><li>"PASSPORT"</li><li>"SOFTWARE\_LICENSE"</li><li>"OUTDOOR\_LICENSE"</li><li>"SECURE\_NOTE"</li><li>"WIRELESS\_ROUTER"</li><li>"BANK\_ACCOUNT"</li><li>"DRIVER\_LICENSE"</li><li>"IDENTITY"</li><li>"REWARD\_PROGRAM"</li><li>"DOCUMENT"</li><li>"EMAIL\_ACCOUNT"</li><li>"SOCIAL\_SECURITY\_NUMBER"</li><li>"MEDICAL\_RECORD"</li><li>"SSH\_KEY"</li></ul><p>You can't create items using the "CUSTOM" or "DOCUMENT" categories.</p> |
| **urls**         | array    | Array of [URL objects](https://developer.1password.com/docs/connect/connect-api-reference/#item-url-object) containing URLs for the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **favorite**     | boolean  | Whether the item is marked as a favorite.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **tags**         | array    | An array of strings of the tags assigned to the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **version**      | integer  | The version of the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **createdAt**    | dateTime | Date and time when the item was created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **updatedAt**    | dateTime | Date and time when the vault or its contents were last changed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| **lastEditedBy** | string   | UUID of the account that last changed the item.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

**Item: Field object**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#item-field-object)

{

"section": {

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

},

"type": "STRING",

"generate": true,

"label": "Random Text"

}

| **パラメーター**          | **タイプ** | **詳細**                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **purpose or type** | string  | <p>Use purpose for the username, password, and notes fields. Possible values:</p><ul><li>"USERNAME"</li><li>"PASSWORD"</li><li>"NOTES"</li></ul><p>Use type for all other fields. Possible values are:</p><ul><li>"STRING"</li><li>"EMAIL"</li><li>"CONCEALED"</li><li>"URL"</li><li>"OTP" (format: otpauth://)</li><li>"DATE" (format: YYYY-MM-DD)</li><li>"MONTH\_YEAR" (format: YYYYMM or YYYY/MM)</li><li>"MENU"</li></ul> |
| **value**           | string  | <p>The value to save for the field.</p><p>You can specify a generate field instead of value to create a password or other random information for the value.</p>                                                                                                                                                                                                                                                                |
| **generate**        | boolean | Generate a password and save in the value for the field. By default, the password is a 32-characters long, made up of letters, numbers, and symbols. To customize the password, include a recipe field.                                                                                                                                                                                                                        |
| **recipe**          | object  | A [GeneratorRecipe object](https://developer.1password.com/docs/connect/connect-api-reference/#item-generatorrecipe-object).                                                                                                                                                                                                                                                                                                   |
| **section**         | object  | An object containing the UUID of a section in the item.                                                                                                                                                                                                                                                                                                                                                                        |

**Item: Fileオブジェクト**

{

"id": "6r65pjq33banznomn7q22sj44e",

"name": "testfile.txt",

"size": 35,

"content\_path": "v1/vaults/ftz4pm2xxwmwrsd7rjqn7grzfz/items/2fcbqwe9ndg175zg2dzwftvkpa/files/6r65pjq33banznomn7q22sj44e/content",

"content": "VGhlIGZ1dHVyZSBiZWxvbmdzIHRvIHRoZSBjdXJpb3VzLgo=",

"section": {

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

},

}

| **名前**            | **タイプ** | **詳細**                                                                    |
| ----------------- | ------- | ------------------------------------------------------------------------- |
| **id**            | string  | The UUID of the file.                                                     |
| **name**          | string  | The name of the file.                                                     |
| **size**          | integer | The size of the file in bytes.                                            |
| **content\_path** | string  | The path to download the contents of the file.                            |
| **content**       | string  | The Base64-encoded contents of the file, if inline\_files is set to true. |
| **section**       | object  | An object containing the UUID of a section in the item.                   |

**Item: GeneratorRecipeオブジェクト**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#item-generatorrecipe-object)\
**このレシピは、「generate」プロパティーと組み合わせて使用され、新しい安全な値を生Createするために使用される文字セットを設定します。**

{

"length": 55,

"characterSets": \[

"LETTERS",

"DIGITS"

]

}

| **名前**                | **タイプ** | **詳細**                                                                                                                                                              |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **length**            | integer | The length of the password to generate. *Optional.*                                                                                                                 |
| **characterSets**     | array   | <p>An array containing of the kinds of characters to include. <em>Optional.</em> Possible values:</p><ul><li>"LETTERS"</li><li>"DIGITS"</li><li>"SYMBOLS"</li></ul> |
| **excludeCharacters** | string  | A list of all characters that should be excluded from generated passwords. *Optional.*                                                                              |

**Item: Sectionオブジェクト**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#item-section-object)

{

"id": "95cdbc3b-7742-47ec-9056-44d6af82d562"

"label": "Security Questions",

}

| **名前**    | **タイプ** | **詳細**                               |
| --------- | ------- | ------------------------------------ |
| **id**    | string  | A unique identifier for the section. |
| **label** | string  | The label for the section.           |

**Item: URL object**[**​**](https://developer.1password.com/docs/connect/connect-api-reference/#item-url-object)

{

"label": "website",

"primary": true,

"href": "<https://example.com>"

}

| **名前**      | **タイプ** | **詳細**                                        |
| ----------- | ------- | --------------------------------------------- |
| **label**   | string  | The label for the URL.                        |
| **primary** | boolean | Whether this is the primary URL for the item. |
| **href**    | string  | The address.                                  |

#### **Server Healthオブジェクト** <a href="#uxjgedik69xs" id="uxjgedik69xs"></a>

{

"name": "1Password Connect API",

"version": "1.2.1",

"dependencies": \[

{

"service": "sync",

"status": "TOKEN\_NEEDED"

},

{

"service": "sqlite",

"status": "ACTIVE",

"message": "Connected to \~/1password.sqlite"

}

]

}

| **名前**           | **タイプ** | **詳細**                                                                                                                                   |
| ---------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| **name**         | string  | name of the server                                                                                                                       |
| **version**      | string  | Version info of the Connect server                                                                                                       |
| **dependencies** | array   | An array of [Service Dependencies](https://developer.1password.com/docs/connect/connect-api-reference/#server-health-dependency-object). |

**Server Health: Dependencyオブジェクト**

| **名前**      | **タイプ** | **詳細**                                                       |
| ----------- | ------- | ------------------------------------------------------------ |
| **service** | string  | name of the dependency                                       |
| **status**  | string  | The service's reported status                                |
| **message** | string  | Extra information about the dependency's status. *Optional.* |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://manual.dxable.com/1password/1password-connect-server-api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
