アイテムJSONテンプレート

1Passwordマニュアル｜1Password CLIでアイテムJSONテンプレートを活用し、効率的にアイテムを作成・管理する方法をご紹介します。

1Password CLI は、1PasswordでアイテムをCreateする方法を制御するために使えるアイテムJSONテンプレートをサポートしています。アイテムJSON テンプレートを使うと、カスタム セクションやフィールドを含む全ての詳細を指定してアイテムをCreateできます。

アイテム テンプレートはop item getのJSON出力と同様の形式になっているため、保存済みのアイテムに基づいて新しいアイテムを簡単にCreateできます。

各アイテムカテゴリーには独自のテンプレートがあります。op item template listを使うと、全アイテムカテゴリーのリストを取得できます。また、op item template get <category>を使うと指定したアイテムカテゴリーのテンプレートを取得できます。

アイテムテンプレートキー

アイテムJSON テンプレートには共通言語キーがあり、テンプレート内のフィールドが 1Password内のアイテムとどのように対応しているかを識別できます。

{
  ①"title": " ",
  ②"category": " ",
  "sections": [
    {
      ③"id": " ",
      ④"label": " "
    },
  ],
  "fields": [
    {
     ⑤"id": " ",
    "section": {
     ⑥"id": " "
      },
     ⑦"type": " ",
     ⑧"label": " ",
     ⑨"value": " "
    }
  ]
}

アイテム

名前	説明
①title	1Passwordに表示されるアイテムの名前。
②category	アイテムのカテゴリー。

セクション

名前	説明
③"id"	セクションの識別子。アイテムに複数のセクションがある場合、各IDは一意である必要があります。
⑤"label"	1Passwordに表示される⑤セクションの名前。

カスタムセクションを追加するには、セクションJSONオブジェクトをsections配列に挿入します。

セクションJSONオブジェクトを表示するには次のようにします。：

{
  "id": " ",
  "label": " "
}

フィールド

名前	説明
⑤id	フィールドのID。各IDは一意である必要がある。空のままにすると、1PasswordはランダムなIDを生Createする。
⑥section id	フィールドが配置されているセクションのID。カスタムセクションに配置されている場合にのみ必須。
⑦type	フィールドのタイプ。カスタムフィールドタイプの詳細を参照。
⑧label	1Passwordに表示されるフィールド名。
⑨value	フィールドにSaveされる情報。そのタイプに応じて、文字列、シークレット、数値、日付のいずれかになる。

テンプレートにカスタムフィールドを追加するには、新しいフィールドJSONオブジェクトをfields配列に挿入します。

フィールドJSONオブジェクトを表示するには次のようにします。：

{
  "id": " ",
  "section": {
    "id": " "
  },
  "type": " ",
  "label": " ",
  "value": " "
}

JSONの表示

以下は1Passwordアプリのアイテムmysqlの表示と、アイテムJSONテンプレートで表現された同じアイテムを示した例です。

アプリ内

JSONテンプレート内

{
  "id": "4l3udxihvvuhszh2kxyjbblxl4",
  "title": "mysql",
  "version": 3,
  "vault": {
    "id": "uteieiwkhgv6hau7xkorejyvru"
  },
  "category": "DATABASE",
  "last_edited_by": "IU2OKUBKAFGQPFPFZEG7X3NQ4U",
  "created_at": "2021-11-25T14:50:14Z",
  "updated_at": "2022-02-25T18:12:12Z",
  "sections": [
    {
      "id": "g52gfotnw7nhnkgq477si2hmmi",
      "label": "Database Owner"
    }
  ],
  "fields": [
    {
      "id": "notesPlain",
      "type": "STRING",
      "purpose": "NOTES",
      "label": "notesPlain"
    },
    {
      "id": "database_type",
      "type": "MENU",
      "label": "type",
      "value": "mysql"
    },
    {
      "id": "hostname",
      "type": "STRING",
      "label": "server",
      "value": "http://localhost"
    },
    {
      "id": "port",
      "type": "STRING",
      "label": "port",
      "value": "5432"
    },
    {
      "id": "database",
      "type": "STRING",
      "label": "database",
      "value": "app-database"
    },
    {
      "id": "username",
      "type": "STRING",
      "label": "username",
      "value": "mysql-user"
    },
    {
      "id": "password",
      "type": "CONCEALED",
      "label": "password",
      "value": "T4Kn7np2bLJXAFoYPoVC"
    },
    {
      "id": "sid",
      "type": "STRING",
      "label": "SID"
    },
    {
      "id": "alias",
      "type": "STRING",
      "label": "alias"
    },
    {
      "id": "options",
      "type": "STRING",
      "label": "connection options"
    },
    {
      "id": "tpcs7jrjikehw5o4tzbe5pklca",
      "section": {
        "id": "g52gfotnw7nhnkgq477si2hmmi",
        "label": "Database Owner"
      },
      "type": "STRING",
      "label": "admin",
      "value": "Wendy Appleseed"
    },
    {
      "id": "sdqueijyulxryvu5ceuwktjkiq",
      "section": {
        "id": "g52gfotnw7nhnkgq477si2hmmi",
        "label": "Database Owner"
      },
      "type": "EMAIL",
      "label": "email",
      "value": "[e-mail]"
    }
  ]
}

さらに詳しく知るには

• Create an item
• Work with items
• Work with vaults