レコードコマンド

レコード関連コマンドの説明

概要

本節では、Keeperコマンダー (CLI) でボルト内のレコードを操作するコマンドを列挙します。この文脈での「レコードコマンド」は、レコードの追加・編集・取得などを指します。レコードや関連する添付ファイルの作成・参照・編集・整理・管理を扱います。

現在、次のコマンドをSDKで利用できます。

レコード専用コマンドに加え、SDKではレコード添付の機能も利用できます。詳細はこちらarrow-up-rightをご参照ください。次を含みます。

Record Addコマンド

このコマンドはKeeperボルトにレコードを追加するために使います。すべてのレコードタイプ、カスタムタイプ、標準フィールド、カスタムフィールドを指定できます。

chevron-rightDotNet CLIhashtag

コマンド : add-record

パラメータ:

パラメータ
説明

-t, --type

レコードタイプ (login、bankAccount、address など)

--title

レコードのタイトル

オプション:

オプション
説明

--folder

レコードを作成するフォルダー名またはUID

-g, --generate

ランダムパスワードを生成する

--self-destruct

一定時間後に自動削除 (5m、2h、1d など)

レコードフィールド:

fieldname=value 形式でフィールドを追加する。

:

chevron-rightDotNet SDKhashtag

メソッド:

引数:

引数
必須
説明

record

KeeperRecord

はい

レコード情報を含むKeeperRecord型のデータ

folderUid

string

いいえ

レコードを作成するフォルダーのUID (既定: null = ルートフォルダー)

戻り値:

Task<KeeperRecord> — 付与されたUIDを持つ作成済みKeeperRecordを返すタスク

使用例: こちらarrow-up-rightをご参照ください

chevron-rightPowerCommanderhashtag

コマンド : Add-KeeperRecord

別名: kadd

パラメータ:

オプション
説明

-RecordType

レコードタイプを指定する (既定: login)

-Title

レコードのタイトル

フラグ:

オプション
説明

-Folder

レコードを作成するフォルダーのUID

-GeneratePassword

ランダムパスワードを生成する。単独指定時は既定ルール (Length=20、Upper=4、Lower=4、Digit=2、Special=2) を使用する。

-PasswordRules

カスタム生成ルール: Length、Upper、Lower、Digit、Special。

例: -PasswordRules 20,5,5,5,5

値は5つ必須: Length、Upper、Lower、Digit、Special。

-SpecialChars

生成パスワードに記号を含める。

形式: Charset (charsetは任意)

例: -SpecialChars "!@#$"

既定のcharsetは !@#$%()+;<>=?[]{}^.,

-Notes

レコードにメモを追加する

-SelfDestruct

共有レコードURLの有効期限 (形式: m、h、d。最大: 180日/6ヶ月)。閲覧から5分後にレコードが消える

例:

使用例のサンプルはこちらarrow-up-rightをご参照ください

chevron-rightPython CLIhashtag

コマンド: record-add

パラメータ:

-t --title レコードのタイトル (必須)

-n --notes レコードのメモ

-rt --record-type レコードタイプ (必須)

--folder レコードを追加するフォルダー

--self-destruct 共有レコードURLの有効期限。m、h、dで指定。最大180日 (6ヶ月)。閲覧から5分後にレコードが消える

-f --force 警告を無視しプロンプトをスキップする

fields <field_type>=<value> フィールドと値の一覧

例:

chevron-rightPython SDKhashtag

関数: add_record_to_folder

Record Updateコマンド

このコマンドはKeeperボルトの既存レコードを更新するために使います。

chevron-rightDotNet CLIhashtag

コマンド: update-record

パラメータ:

パラメータ
説明

record

更新するレコードのパスまたはUID

オプション:

オプション
説明

--title

レコードのタイトルを更新する

-t, --type

レコードタイプ (型付きレコードのみ)

-g, --generate

ランダムパスワードを生成し、既存のパスワードフィールドを更新する (既定: false)

--help

ヘルプ画面を表示する

--version

バージョン情報を表示する

fields

fieldname=value 形式で追加/更新するレコードフィールド

例:

chevron-rightDotNet SDKhashtag

メソッド:

引数:

引数
必須
説明

record

KeeperRecord

はい

更新データを含むレコードオブジェクト (有効なUIDが必要)

skipExtra

bool

いいえ

ファイル添付情報の更新をスキップする (既定: true)

戻り値:

Task<KeeperRecord> — 更新後のKeeperRecordを返すタスク

例:

アプローチ2:

複数レコードを一度に更新する場合、まとめて更新できる。

関数:

戻り値:

Task<IList<RecordUpdateStatus>> — 各レコードの更新ステータス一覧を返すタスク

RecordUpdateStatus のプロパティ:

プロパティ
説明

RecordUid

string

レコードのUID

Status

string

更新ステータス: "success" またはエラーメッセージ

Message

string

追加のステータスメッセージまたはエラー詳細

例:

chevron-rightPowerCommanderhashtag

コマンド: Add-KeeperRecord

別名: kadd

パラメータ:

  • -Uid : 更新対象レコードのレコードUid

フラグ:

オプション
説明

-GeneratePassword

レコード用の新しいパスワードを生成して更新する

-Title

更新後のタイトル

-Notes

レコードのメモを更新する

-Verbose

詳細な操作情報を表示する

-Debug

実行中のデバッグ情報を表示する

-ErrorAction

エラーへの応答方法 (Continue、Stop、SilentlyContinue、Ignore)

-WhatIf

コマンドレットを実際には実行せず、実行時の動作を表示する

-Confirm

実行前に確認プロンプトを表示する

要件:

このコマンドは現在のフォルダー内のレコードを更新します。先に、対象フォルダーへカレントを移してください。Set-KeeperFolder コマンドで行えます (参考arrow-up-right)。

例:

chevron-rightPython CLIhashtag

コマンド: record-update

パラメータ:

-t --title レコードタイトルを変更する (必須)

-rt --record-type レコードタイプを変更する (必須)

-n --notes メモを追記/変更する

-r --record 変更対象のUIDまたはパス (必須)

fields <field type>=<value> フィールドと値の一覧

オプション:

-f --force 警告を無視する

例:

chevron-rightPython SDKhashtag

関数: update_record

例:

Record Deleteコマンド

個人用ボルトフォルダーから複数のレコードを削除するために使います。削除したレコードはオーナーのボルトに残り、すべてのインスタンスが削除されるとオーナーのゴミ箱に残ります。

chevron-rightDotNet CLIhashtag

コマンド: rm

フラグ:

  • --help : このヘルプ画面を表示する。

  • --version : バージョン情報を表示する。

  • record title, uid, or pattern : 削除するレコードのUID/タイトル。

例:

chevron-rightDotNet SDKhashtag

メソッド: DeleteRecords

引数:

records - レコードパスの配列。

例外:

chevron-rightPowerCommanderhashtag

コマンド: Remove-KeeperRecord

別名: kdel

パラメータ:

  • Name - 削除するレコード名

例:

chevron-rightPython CLIhashtag

コマンド: rm

パラメータ:

  • records 削除するレコードのUid (必須)

オプション:

  • -f --force 確認なしで削除する

例:

chevron-rightPython SDKhashtag

関数: delete_vault_objects

例:

Listコマンド

このコマンドはKeeperボルト内のすべてのレコードを表形式で一覧表示します。各行にレコードUID、タイトル、タイプ、説明、他ユーザーとの共有の有無が含まれます。

chevron-rightDotNet CLIhashtag

コマンド: search

パラメータ:

  • argument 1 : 検索で照合するパターン (必須)。

フラグ:

  • --verbose : すべてのデータを表示する

  • --limit : 表示するレコード数

例:

chevron-rightDotNet SDKhashtag

メソッド: vault.KeeperRecords

同様の動作には、ボルトコンテキストのKeeperレコード一覧から取得する。

chevron-rightPower Commanderhashtag

コマンド: Get-KeeperRecord

別名: kr

オプション:

-Uid - レコードuidで絞り込む。

-Filter - UID、タイトル、タイプ、説明で絞り込む。

chevron-rightPython CLIhashtag

コマンド: list

別名:l

オプション:

-t --type 特定タイプのレコードのみ一覧する。繰り返し指定可

-v --verbose 長いタイトルを表示する

--format Table、csv、json

--output 出力先ファイルのパス

search_text 一覧の条件

例:

chevron-rightPython SDKhashtag

関数: find_records

例:

注:

  • criteria : レコードに含まれるテキスト

  • record_types : 指定タイプのレコードを返す

  • record_version : 指定バージョンのレコードを返す

Get Recordコマンド

このコマンドはレコードの取得専用です。DotNetおよびPython SDKのgetはその他コマンドに分類され、レコード・チーム・フォルダー・共有フォルダーを取得します。

chevron-rightDotNet CLIhashtag

コマンド: get

パラメータ:

  • uid : レコード、共有フォルダー、またはフォルダーのUid

例:

chevron-rightDotNet SDKhashtag

現在のdotnet CLIでの実装は、与えられたUIDを複数カテゴリから検索する流れに従います。

UIDがレコードにない場合は、共有フォルダー側でUIDを検索します。

共有フォルダーにない場合は、フォルダーを確認します。

chevron-rightPower Commanderhashtag

コマンド: Get-KeeperRecord

別名: kr

パラメータ:

  • Uid : 一致するUidのレコードを返す

フラグ:

  • Filter : レコード内容を指定値と照合し、一致するものを返す

例:

chevron-rightPython CLIhashtag

コマンド: get <UID>

パラメータ:

  • uid 検索するUIDまたはタイトル (-f、-t、-r 使用時は任意)

  • -f, --folder 検索するフォルダーUIDまたはタイトル

  • -t, --team 検索するチームUIDまたはタイトル

  • -r, --record 検索するレコードUIDまたはタイトル

オプション:

--format 対応する表示形式 - json、details、fields、password

--unmask パスワードなど機密データを出力に含める

--legacy 型付きレコードをレガシーとして表示する

例:

chevron-rightPython SDKhashtag

関数: load_record

例:

load_recordはレコードの詳細を返します。レコードには次の4種類があります。

  • PasswordRecord - レガシーまたは一般

  • TypedRecord

  • FileRecord

  • ApplicationRecord

これらのクラスはkeepersdk.vault.vault_recordで定義されています。

Record Historyコマンド

このコマンドは、(既定アクションで) レコードのリビジョンや変更の一覧表示、特定リビジョンの表示、リビジョン間の差分表示、旧リビジョンの復元に使います。ここでのリビジョンは、特定レコードの変更バージョンに相当します。

chevron-rightDotNet CLIhashtag

コマンド: record-history

パラメータ:

  • recordUid : 履歴を参照するレコードのUID。

例:

chevron-rightDotNet SDKhashtag

メソッド: GetRecordHistory

引数:

recordUid : 履歴を表示するレコードのUID

chevron-rightPower Commanderhashtag

コマンド: Get-KeeperRecordHistory

パラメータ:

-Format Table、csv、Json

-Output 出力先ファイルのパス。

-a -Action 対応アクション: list、diff、view、restore

-r, -Revision 表示または復元対象のリビジョン

-Record レコードUIDまたはパス (必須)

例:

chevron-rightPython CLIhashtag

コマンド: record-history

パラメータ:

--format Table、csv、Json

--output 出力先ファイルのパス ("table" 形式では無視)

-a --action 対応アクション: list、diff、view、restore

-r, --revision 表示または復元対象のリビジョン

record レコードUIDまたはパス (必須)

オプション:

  • -v, --verbose 詳細出力を表示する

例:

chevron-rightPython SDKhashtag

関数: 非対応

Clipboard Copyコマンド

このコマンドはレコードからデータ (パスワード、ログイン、TOTP、カスタムフィールド) を取得し、クリップボード、標準出力、環境変数などへ出力します。

circle-info

このコマンドの別名は find-password です。

chevron-rightDotNet CLIhashtag

コマンド: clipboard-copy

別名: cc, find-password

フラグ:

  • record: データ取得元のレコードパスまたはUID

  • --username : 同名レコードが複数あるときログイン名で一致させる

  • --output : 出力先 - 値: clipboard (既定)、stdoutstdouthiddenvariable

  • --name : 出力が variable のときの変数名

  • --copy-uid : パスワードの代わりにUIDを出力する

  • -l, --login : パスワードの代わりにログイン名を出力する

  • -t, --totp : パスワードの代わりにTOTPコードを出力する

  • --field : 特定のカスタムフィールドを出力する (ネストは field:property)

  • -r, --revision : 指定したレコードリビジョンを使う

例:

chevron-rightPower Commanderhashtag

コマンド : Copy-KeeperToClipboard [-Record] [-Field] [-Output] [-Username] [-Login] [-Totp] [-CopyUid] [-Name] [-Revision]

パラメータ

パラメータ
説明

Record

レコードUID、タイトル、またはUidプロパティを持つオブジェクト。

Field

コピーするフィールド。Login、Password、URL、Notes、または任意のカスタムフィールド名。

Output

出力先: Clipboard、Stdout、StdoutHidden、Variable。

Username

同一タイトルが複数あるとき、正しいレコードを選ぶためのログイン名。

Login

パスワードの代わりにログインフィールドをコピーする。別名: -l

Totp

パスワードの代わりにTOTPコードをコピーする。別名: -t

CopyUid

パスワードの代わりにレコードUIDをコピーする。

Name

Output が Variable のときの変数名。

Revision

履歴の特定リビジョンを使用する (1 = 1つ前、2 = 2つ前 など)。別名: -r

chevron-rightPython CLIhashtag

コマンド : 近日公開

chevron-rightPython SDKhashtag

関数: 非対応

Find Duplicatesコマンド

このコマンドは、さまざまな照合条件に基づきボルト内の重複レコードを検索します。重複の表示、または自動マージ/削除が行えます。

chevron-rightDotNet CLIhashtag

コマンド: find-duplicates

フラグ:

  • --title : タイトルで重複を照合する

  • --login : ログインで重複を照合する

  • --password : パスワードで重複を照合する

  • --url : URLで重複を照合する (結果にもURLを表示)

  • --shares : 共有権限で重複を照合する

  • --full : カスタムフィールドを含むすべてのフィールドで照合する

  • -m, --merge : 重複レコードを統合する (各グループで先頭以外を削除)

  • --ignore-shares-on-merge : マージ用のグループ化で共有権限を無視する

  • -f, --force : 確認なしで削除する (--merge 指定時のみ有効)

  • -n, --dry-run : 実際には削除せずシミュレーションする (--merge 指定時のみ有効)

  • -q, --quiet : 画面出力を抑止する (--force 指定時のみ有効)

  • -s, --scope : 検索範囲 - 値: vault (既定)、enterprise

  • -r, --refresh-data : 最新データでローカルキャッシュを更新する (--scope=enterprise 指定時のみ有効)

例:

chevron-rightPower Commanderhashtag

コマンド : Find-KeeperDuplicateRecords [-Title] [-Login] [-Password] [-Url] [-Shares] [-Full] [-Merge] [-Force] [-DryRun] [-Quiet] [-IgnoreSharesOnMerge] [-Scope ] [-RefreshData] [-Format ] [-Output ]

パラメータ

パラメータ
説明

Title

タイトルフィールドで重複を照合する。

Login

ログインフィールドで重複を照合する。

Password

パスワードフィールドで重複を照合する。

Url

URLフィールドで重複を照合する。

Shares

共有権限で重複を照合する。

Full

すべてのフィールド (タイトル、ログイン、パスワード、url、カスタム、共有) で照合する。

Merge

重複を削除する (各グループの先頭レコードを残す)。

Force

確認なしで削除する (-Merge が必要)。

DryRun

削除せずシミュレーションする (-Merge が必要)。

Quiet

出力を抑止する (-Force が必要)。

IgnoreSharesOnMerge

マージ照合で共有権限を無視する。

Scope

検索範囲: vault または enterprise。

RefreshData

キャッシュを更新する (-Scope enterprise が必要)。

Format

出力形式: table、csv、json。

Output

結果をファイルにエクスポートする。

chevron-rightPython CLIhashtag

コマンド : 近日公開

chevron-rightPython SDKhashtag

関数: 非対応

File Reportコマンド

このコマンドは、ボルト内でアクセス可能なすべてのファイルの詳細レポートを出力します。タイトル、レコードUID、ファイルIDが含まれます。

chevron-rightDotNet CLIhashtag

コマンド: 近日公開

chevron-rightPower Commanderhashtag

コマンド: Get-KeeperFileReport

パラメータ:

-Format Table、csv、Json

-Output 出力先ファイルのパス ("table" 形式では無視)

-d , -TryDownload アクセス可能な添付をすべてダウンロードして試す。

例:

chevron-rightPython CLIhashtag

コマンド: file-report

パラメータ:

--format Table、csv、Json

--output 出力先ファイルのパス ("table" 形式では無視)

-d --try-download アクセス可能な添付をすべてダウンロードして試す。

例:

chevron-rightPython SDKhashtag

関数:

最終更新

役に立ちましたか?