インポートエクスポートコマンド

インポート・エクスポートコマンドの一覧と使い方

概要

Keeperコマンダーには、ボルトデータの移行と管理向けのCLIコマンドが複数用意されています。さまざまな形式からのデータインポート、ボルト内容のエクスポート、共有フォルダー権限およびカスタムテンプレートの同期が行えます。

コマンド

次のコマンドを扱います。

1. Importコマンド

2. Exportコマンド

3. Download Membershipコマンド

4. Apply Membershipコマンド

5. Download Record Typesコマンド

6. Load Record Typesコマンド

Importコマンド

ローカルファイルまたは外部のパスワードマネージャーから、レコードとフォルダーをKeeperボルトにインポートします。

DotNet CLI

注: このコマンドの.NET実装は、JSONファイルのインポートのみに対応しています。

コマンド: import

フラグ:

filename : KeeperへインポートするJSONを含むファイル名

例外:

MyVault> import <file_path.json>

DotNet SDK

注: この関数はレコードのJSONインポートのみに対応しています。

メソッド:

public static ImportFile LoadJsonDictionary(IDictionary<string, object> importFile)

フラグ:

• importFile : 個々のレコードやフォルダーなどを構成するオブジェクトの辞書

PowerCommander

コマンド : 近日公開

Python CLI

コマンド : import

パラメータ :

• name : ファイル名 (json, csv, keepass, 1password)、アカウント名 (lastpass_lib)、またはURL (Thycotic)

オプション:

• --display-csv, -dc : Keeper CSVインポート手順を表示する

• --display-json, -dj : Keeper JSONインポート手順を表示する

• --format : {json, csv, keepass, lastpass, 1password, bitwarden, thycotic} ファイル形式

• --dry-run : インポートせず、インポート対象のレコードを表示する

• --folder : IMPORT_INTO 別フォルダーへインポートする

• --filter-folder : FILTER_FOLDER 指定フォルダー内のデータのみインポートする

• -s, --shared : フォルダーをKeeper共有フォルダーとしてインポートする

• -p, --permissions : PERMISSIONS 共有フォルダーの既定権限: ユーザー管理(U)、レコード管理(R)、編集(E)、共有(S)、すべて(A)、なし(N)

• --record-type : RECORD_TYPE レガシーレコードを指定レコードタイプとしてインポートする。空ならlogin

• --show-skipped : スキップしたレコードを表示する

例:

My Vault> import /Users/user/Desktop/records.json --format json
Record "My Record" was skipped: A full record match already exists

Python SDK

使用するクラス :

JSONレコードをインポートするには次のクラスを使います。

class KeeperJsonImporter(import_data.BaseFileImporter, KeeperJsonMixin):

LastPassからレコードをインポートするには次のクラスを使います。

class LastPassImporter(BaseImporter):

KeePassからインポートするには次のクラスを使います。

class KeepassImporter(import_data.BaseFileImporter):

このクラスのオブジェクトを、次の関数向けのインポーターとして使えます。

関数 :

keepersdk.importer.import_utils.py

def do_import_vault(vault: vault_online.VaultOnline,
                    data_source: import_data.BaseImporter,
                    *,
                    import_logger: Optional[import_data.IImportLogger]=None,
                    filter_folder: Optional[str]=None,
                    **kwargs
                    ) -> None:

data sourceには、先に作成したオブジェクトを指定します。

引数

vault - VaultOnlineインスタンス

data_source - インポータークラス

import_logger - ImportDataクラスのロガーオブジェクト。

Exportコマンド

このコマンドで、ボルトデータ (レコード、フォルダー、共有フォルダー) をKeeperからローカルへエクスポートできます。

DotNet CLI

注: このコマンドの.NET実装は、レコード・フォルダー・共有フォルダー情報を含むボルトデータのJSONエクスポートに対応しています。

コマンド: export

フラグ:

• filename (必須): ボルトデータをエクスポートする出力JSONファイル名

• --force または -f (任意): 確認なしで既存ファイルを上書きする

• --exclude-shared-folders または -x (任意): エクスポートから共有フォルダーを除く

例:

MyVault> export vault_backup.json

MyVault> export vault_backup.json --force

MyVault> export vault_backup.json --exclude-shared-folders

DotNet SDK

注: この関数はボルトのレコード、フォルダー、共有フォルダー情報をJSON形式でエクスポートします。

メソッド:

1. JSON文字列へエクスポート:

public static async Task<string> ExportVaultToJson(this VaultOnline vault, 
    IEnumerable<string> recordUids = null,
    bool includeSharedFolders = true,
    Action<Severity, string> logger = null)

1. ファイルへエクスポート:

public static async Task ExportVaultToFile(this VaultOnline vault,
    string filename,
    IEnumerable<string> recordUids = null,
    bool includeSharedFolders = true,
    Action<Severity, string> logger = null)

フラグ:

• vault: 認証済みのVaultOnlineインスタンス

• filename: 出力JSONファイルのパス

• recordUids: エクスポートする特定のレコードUIDのリスト (任意、nullですべて)

• includeSharedFolders: 共有フォルダー情報を含めるか (既定: true)

• logger: 任意のログコールバック

PowerCommander

コマンド : 近日公開

Python CLI

コマンド: export

パラメータ:

• name : ファイル名。省略時はコンソール出力

オプション:

• --format {json,csv,keepass} : ファイル形式

• --max-size MAX_SIZE : 添付ファイルの最大サイズ。例: 100K, 50M, 2G。既定: 10M

• --file-password FILE_PASSWORD : エクスポートファイルのパスワード

• --zip : 添付ファイル用にZIPアーカイブを作成する。JSONのみ

• --force : 対話を省略し「yes」とみなす

• --folder FOLDER : 指定フォルダー内のデータのみエクスポートする

例:

My Vault> export "export-command.json" --folder "example folder" --format json
5 records exported

Python SDK

関数: KeeperJsonExporter.vault_export

from keepersdk.importer import keeper_format

exporter = KeeperJsonExporter
exporter.vault_export(items: List[Union[import_data.Record, import_data.SharedFolder, import_data.Team]])

Download Membershipコマンド

共有フォルダーの共有設定をダウンロードします。内容には次が含まれます。

• アクセス権を持つユーザーまたはチーム

• 権限 (読み取り専用、編集、管理)

DotNet CLI

注: .NET実装は移行目的で共有フォルダーとチームのメンバーシップ情報をダウンロードします。ソースは現在Keeperのみに対応しています。

コマンド: download-membership

パラメータ:

• --source: メンバーシップのソース - 有効値: keeper, lastpass, thycotic (現在実装済みはkeeperのみ)

フラグ:

• filename: 出力JSONファイル名 (既定: shared_folder_membership.json)

• --force または -f: 既存ファイルを上書きする。未指定時は既存ファイルとマージする

• --folders-only: 共有フォルダーのみダウンロードし、チームをスキップする

• --permissions または -p: 共有フォルダー権限を強制 - 値: U (ユーザー管理), R (レコード管理)

• --restrictions または -r : 共有フォルダー制限を強制 - 値: U (ユーザー管理), R (レコード管理)

• --sub-folder : 共有サブフォルダーの扱い - 値: ignore, flatten

例:

MyVault> download-membership --source keeper

MyVault> download-membership --source keeper membership.json

MyVault> download-membership --source keeper --force --folders-only

MyVault> download-membership --source keeper --permissions UR

MyVault> download-membership --source keeper --sub-folder flatten

DotNet SDK

注: この関数はボルトから共有フォルダーとチームのメンバーシップ情報をダウンロードします。

メソッド:

1. ExportFileオブジェクトへダウンロード:

public static async Task<ExportFile> DownloadMembership(this VaultOnline vault,
    DownloadMembershipOptions options = null,
    Action<Severity, string> logger = null)

1. JSON文字列へダウンロード:

public static async Task<string> DownloadMembershipToJson(this VaultOnline vault,
    DownloadMembershipOptions options = null,
    Action<Severity, string> logger = null)

1. ファイルへダウンロード:

public static async Task DownloadMembershipToFile(this VaultOnline vault,
    string filename,
    DownloadMembershipOptions options = null,
    Action<Severity, string> logger = null)

1. 既存ファイルとマージ:

public static async Task MergeMembershipToFile(this VaultOnline vault,
    string filename,
    DownloadMembershipOptions options = null,
    Action<Severity, string> logger = null)

DownloadMembershipOptions:

• FoldersOnly: 共有フォルダーのみ含め、チームをスキップする (既定: false)

• ForceManageUsers: 全ユーザーにユーザー管理権限を強制する (nullable bool)

• ForceManageRecords: 全ユーザーにレコード管理権限を強制する (nullable bool)

• SubFolderHandling: サブフォルダー処理モード - 値: "ignore", "flatten"

フラグ:

• vault: 認証済みのVaultOnlineインスタンス

• filename: 出力JSONファイルのパス

• options: ダウンロード操作の設定

• logger: 任意のログコールバック

PowerCommander

コマンド : Export-KeeperMembership

フラグ:

• -FileName (任意, 既定: shared_folder_membership.json) - 出力JSONファイル名。拡張子.jsonが省略されていれば自動付与。

• -Force (任意) - 既存ファイルを上書きする。このフラグがない場合は既存ファイルとマージする。

• -FoldersOnly (任意) - 共有フォルダーのみダウンロードし、チームをスキップする

• -ForceManageUsers (任意) - すべての共有フォルダーですべてのユーザーに「ユーザー管理」権限を強制有効にする

• -ForceManageRecords (任意) - すべての共有フォルダーですべてのユーザーに「レコード管理」権限を強制有効にする

• -RestrictManageUsers (任意) - すべての共有フォルダーですべてのユーザーに「ユーザー管理」権限を強制無効にする

• -RestrictManageRecords (任意) - すべての共有フォルダーですべてのユーザーに「レコード管理」権限を強制無効にする

• -SubFolderHandling (任意) - 共有サブフォルダーの扱い。有効値: ignore, flatten

注:

• -ForceManageUsers と -RestrictManageUsers は同時に指定できない

• -ForceManageRecords と -RestrictManageRecords は同時に指定できない

• 出力ファイルが存在し-Forceがない場合、新データはUIDでマージされる (新規エントリは上書き、追加エントリは保持)

• 親ディレクトリが存在しなければ自動作成される

例:

PS> Export-KeeperMembership                  
Downloading shared folder membership from Keeper...

Download Summary:
    Shared Folders: 6
    Teams: 7
    Output File: /Users/satish/Desktop/sdk-dotnet/keeper-sdk-dotnet/shared_folder_membership.json

Download membership completed successfully.

Python CLI

コマンド: download-membership

パラメータ:

• --source {keeper,lastpass,thycotic} : 共有フォルダーメンバーシップのソース

オプション:

• -p, --permissions : PERMISSIONS 共有フォルダー権限を強制: ユーザー管理(U)、レコード管理(R)

• -r, --restrictions : RESTRICTIONS 共有フォルダー制限を強制: ユーザー管理(U)、レコード管理(R)

• --folders-only : 共有フォルダーのみ出力する。チームをスキップする

• --sub-folder, -sf {ignore,flatten} : 共有サブフォルダーの扱い

• name : 出力ファイル名。省略時は "shared_folder_membership.json"

例:

My Vault> download-membership --source keeper
10 shared folder memberships added.

Python SDK

関数: download_membership

download_membership(self, folders_only: Optional[bool] = False, **kwargs
                            ) -> Iterable[Union[import_data.SharedFolder, import_data.Team]]:

Apply Membershipコマンド

download-membershipで作成したJSONファイルから共有フォルダー権限を復元または適用します。

• フォルダーに正しいユーザー/チームを追加する

• 権限を自動設定する

JSONファイル形式

入力ファイルは有効なJSONで、トップレベルにshared_folders配列が必要です。各共有フォルダーはuidまたはpathで識別でき、permissions配列を含みます。

構造

{
  "shared_folders": [
    {
      "uid": "VPBeke23vou0z-zg2j30iA",
      "path": "My Shared Folder",
      "can_edit": true,
      "can_share": true,
      "manage_records": true,
      "manage_users": true,
      "permissions": [
        {
          "name": "[email protected]",
          "manage_records": true,
          "manage_users": true
        },
        {
          "uid": "team_uid_base64",
          "name": "Engineering Team",
          "manage_records": false,
          "manage_users": true
        }
      ]
    }
  ]
}

共有フォルダーオブジェクト

フィールド	型	必須	説明
uid	string	No*	共有フォルダーUID (base64url)。uidまたはpathのいずれかを指定する。
path	string	No*	共有フォルダーパス (例: フォルダー名)。ボルト内の共有フォルダーに解決される。
can_edit	boolean	No	フォルダーレベルの編集フラグ
can_share	boolean	No	フォルダーレベルの共有フラグ
manage_records	boolean	No	フォルダーレベルのレコード管理
manage_users	boolean	No	フォルダーレベルのユーザー管理
permissions	array	Yes	適用するユーザー/チーム権限のリスト

* 共有フォルダーを特定するにはuidまたはpathの少なくとも一方が必要。

権限オブジェクト (ユーザー/チームごと)

フィールド	型	必須	説明
name	string	Yes	ユーザーのメールまたはチーム名 (ユーザー/チーム解決に使用)
uid	string	No	チームUID (チーム用)。ある場合はチーム検索に使用。
manage_records	boolean	No	メンバーが共有フォルダーでレコードを管理できるようにする
manage_users	boolean	No	メンバーが共有フォルダーでユーザーを管理できるようにする

サンプルファイル

{
  "shared_folders": [
    {
      "path": "Team Credentials",
      "uid": "VPBeke23vou0z-zg2j30iA",
      "permissions": [
        {
          "name": "[email protected]",
          "manage_records": true,
          "manage_users": true
        },
        {
          "name": "[email protected]",
          "manage_records": false,
          "manage_users": true
        }
      ]
    }
  ]
}

DotNet CLI

コマンド : apply-membership [filename] [options]

パラメータ

パラメータ	既定	説明
filename	shared_folder_membership.json	JSONメンバーシップファイルのパス
--full-sync	false	指定時、ボルトをファイルに合わせてメンバーシップを更新および削除も行う

例

My Vault> apply-membership /path/to/membership.json
//or 
My Vault> apply-membership --full-sync
//or
My Vault> apply-membership ./prod-membership.json --full-sync

DotNet SDK

名前空間: KeeperSecurity.Vault

メソッド: KeeperApplyMembership.ApplyMembership (VaultOnline向け拡張)

public static async Task<MembershipSummary> ApplyMembership(
    this VaultOnline vault,
    ImportFile importFile,
    ApplyMembershipOptions options = null)

型:

• ImportFile – 解析済みJSON入力 (KeeperSecurity.Commandsから)。SharedFolders配列を含む。

• ApplyMembershipOptions – 任意。FullSync = trueでメンバーの更新・削除も行う。

• MembershipSummary – 結果: TeamsAdded, UsersAdded, TeamsUpdated, UsersUpdated, TeamsRemoved, UsersRemoved。

例:

using System;
using System.IO;
using System.Threading.Tasks;
using KeeperSecurity.Commands;
using KeeperSecurity.Utils;
using KeeperSecurity.Vault;

var fileName = "shared_folder_membership.json";
var jsonBytes = File.ReadAllBytes(fileName);
var importFile = JsonUtils.ParseJson<ImportFile>(jsonBytes);

var options = new ApplyMembershipOptions
{
    FullSync = true   // optional: also update and remove members
};

var membershipSummary = await vault.ApplyMembership(importFile, options);

PowerCommander

コマンド : Import-KeeperMembership

フラグ :

• Source - 現在対応しているのはkeeperのみ。

• FileName - データを保存するファイル名。ファイルパスでも可。

• SSHKeyAsFile - SSH鍵をファイルとして保存するかデータとして保存するか。trueのときファイルとしてダウンロードする。

例:

PS PowerCommander> Import-KeeperMembership -FileName "/<PATH_TO_JSON>/shared_folder_membership.json" -FullSync
Processing 1 shared folder(s)...

1 user(s) added to shared folders

Apply membership completed successfully.

Python CLI

コマンド: apply-membership

パラメータ:

• name : 入力ファイル名。省略時は "shared_folder_membership.json"

オプション:

• --full-sync : メンバーシップの更新と削除も行う。

例:

My Vault> apply-membership ./shared_folder_membership.json
1 user(s) added to shared folders

Python SDK

関数: import_user_permissions

from keepersdk.importer import import_utils
import_utils.import_user_permissions(vault: vault_online.VaultOnline,
                            shared_folders: List[import_data.SharedFolder],
                            full_sync=False) -> UserPermissionSummary:

Download Record Typesコマンド

カスタムレコードタイプ (サーバーログイン、SSH鍵など特別なデータ用のテンプレート) をJSONファイルにダウンロードします。

DotNet CLI

コマンド: download-record-types

フラグ:

• source : レコードタイプを取得するソース

例:

My Vault> download-record-types keeper
Downloaded 12 record types to "<some_path>/record_types.json"

DotNet SDK

メソッド:

vault.RecordTypes.ToList()

例:

var recordTypes = vault.RecordTypes.ToList();
// write recordTypes to file

PowerCommander

コマンド : Export-KeeperRecordTypes

フラグ :

• Source - 現在対応しているのはkeeperのみ。

• FileName - データを保存するファイル名。ファイルパスでも可。

• SSHKeyAsFile - SSH鍵をファイルとして保存するかデータとして保存するか。trueのときファイルとしてダウンロードする。

例:

PS> Export-KeeperRecordTypes 
Downloaded 12 record types to '/<some path>/record_types.json'

Python CLI

コマンド : download-record-types

パラメータ :

• --source {keeper} : レコードタイプのソース。現在は "keeper" のみ。

オプション:

• --ssh-key-file : SSH鍵をレコードのフィールドではなくファイル添付として保存する

• --name : NAME 出力ファイル名。省略時は "record_types.json"

例:

My Vault> download-record-types --name record_type.json --source keeper
Downloaded 13 record types to "file-path"

Python SDK

関数: 非対応

Load Record Typesコマンド

JSONファイルからカスタムレコードタイプをKeeperにアップロードします。

• 別アカウントで作成したテンプレート

• チーム間でテンプレートを揃えたい場合

DotNet CLI

コマンド : load-record-types

フラグ :

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

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

• <paraeter at position one> - レコードタイプを読み込むファイルパス

例:

My Vault > load-record-types ../custom-record.json   
Record types loaded: 1
Existing Record Types which are skipped: None
Failed Record Types: None

DotNet SDK

メソッド:

Task<string> AddRecordType(string recordTypeData)

フラグ:

• recordTypeData

例:

var parsedRecord = RecordTypeService.CreateRecordTypeObject(recordType);
var recordTypeID = await context.Vault.AddRecordType(Encoding.UTF8.GetString(JsonUtils.DumpJson(parsedRecord)));

PowerCommander

コマンド: Import-KeeperRecordTypes

フラグ:

• -FilePath : レコードタイプファイルのパス。

例:

PS> Import-KeeperRecordTypes -FilePath ./record_type.json

Python CLI

コマンド: load-record-types

パラメータ:

• --file FILE : レコードタイプ定義を含むJSONファイルのパス。

例:

My Vault> load-record-types --file ./record_type.json
Custom record types imported successfully. 1 record types were added.

Python SDK

関数: 非対応