レコードタイプコマンド

レコードタイプコマンドの一覧と使い方

概要

Keeperコマンダーのレコードタイプコマンドは、Keeperプラットフォームでレコードタイプおよびカスタムテンプレートを作成・管理するために使います。エンタープライズ範囲のカスタムレコードタイプを扱う場合に利用します。

コマンド

record-typeでは次のコマンドを扱います。

• レコードタイプ情報表示コマンド

• レコードタイプ作成コマンド

• レコードタイプ更新コマンド

• レコードタイプ削除コマンド

• レコードタイプの取り込みコマンド

• レコードタイプのエクスポートコマンド

レコードタイプ情報表示コマンド

利用可能なレコードタイプを一覧するか、特定のレコードタイプの詳細を表示します。

DotNet CLI

コマンド: record-type-info

フラグ:

• value pos. 0 : カスタムレコードタイプまたはフィールドタイプ名。コマンド直後の位置0に置く位置引数

• -f, --field : カスタムレコードタイプで利用可能なすべてのフィールドを確認する

例:

My Vault> record-type-info "myCustomType" 
    Record Type ID:  12345                    
         Type Name:  myCustomType
             Scope:  enterprise               
       Description:  My custom record         
            Fields:  (login)                  
                     (password)      

DotNet SDK

メソッド:

 // Assuming vault is vaultOnline
var recordTypes = vault.RecordTypes;

PowerCommander

コマンド : Get-KeeperRecordType

別名 : krti

フラグ :

• -ShowFields : カスタムレコードタイプに含まれる利用可能なフィールドをすべて表示する。

• -Name : カスタムレコードタイプの名前

例:

PS > Get-KeeperRecordType -Name "myCustomType"     

Name          Description                          Scope        Fields
----          -----------                          -----        ------
myCustomType  My custom record for secure access   Enterprise   {login, password}

Python CLI

コマンド : record-type-info

オプション :

• -lr, --list-record-type : [RECORD_NAME] 名前でレコードタイプを一覧する。または * ですべて一覧

• -lf, --list-field : FIELD_NAME フィールドタイプを名前で一覧する。または * ですべて一覧

• -e, --example : 例のJSONを生成するには --example を使う

例:

My Vault> record-type-info "myCustomType"
  Record Type ID  Record Type Name               Record Type Scope
----------------  -----------------------------  -------------------
               1  address                        Standard
               2  bankAccount                    Standard

Python SDK

関数: get_record_types

record_types = vault.vault_data.get_record_types()

レコードタイプ作成コマンド

新しいカスタムKeeperレコードタイプを追加します。エンタープライズにスコープされたカスタムレコードタイプのみ作成できます。実行には管理者ロールが必要です。

DotNet CLI

コマンド: record-type-add

フラグ:

• value (pos. 0) : 必須。指定データで新しいレコードタイプを追加する。シリアル化済みのJSON文字列が必要。

例:

My Vault> record-type-add "{\"$id\":\"myCustomType_dotnet_test6\",\"description\":\"My custom record\",\"categories\":[\"note\"],\"fields\":[{\"$ref\":\"login\"},{\"$ref\":\"password\"}]}"
Created Record Type ID: 12345

DotNet SDK

Keeperのレコードオブジェクトを作成してから関数を呼び出します。

メソッド:

Task<string> AddRecordType(string recordTypeData);

var createdId = await vault.AddRecordType(recordTypeData);

PowerCommander

コマンド: New-KeeperRecordType

フラグ:

• -Data : カスタムレコードタイプのデータ (Json形式)

例:

PS > New-KeeperRecordType -Data '{"$id": "myCustomType_powershell","description": "My custom record for secure access in Powershell","categories": ["note"],"fields": [{"$ref": "login"},{"$ref": "password"}]}'
Created Record Type ID: 12345

Python CLI

コマンド: record-type-add

パラメータ:

• --data : DATA レコードタイプ定義をJSON形式で指定、またはファイルから読む場合は filepath:

例:

My Vault> record-type-add --data "{\"$id\":\"myCustomType_python\",\"description\":\"My custo
m record\",\"categories\":[\"note\"],\"fields\":[{\"$ref\":\"login\"},{\"$ref\":\"password\"}
]}"
Custom record type 'myCustomType' created successfully with fields: ['login', 'password'] and recordTypeId: 12345

Python SDK

関数: create_custom_record_type

create_custom_record_type(vault: vault_online.VaultOnline, title: str, fields: List[Dict[str, str]], description: str, categories: List[str] = None):

例:

title = "<record type name>"
fields = [] ## TypedFields Array
description = "<some description>"
categories = []
result = record_type_management.create_custom_record_type(
            vault, title, fields, description, categories
        )

レコードタイプ更新コマンド

既存のカスタムレコードタイプを更新します。同じカスタムタイプから既に作成された古いレコードには影響しません。以降に作成する新しいレコードには、ここで設定したフィールドが反映されます。

DotNet CLI

コマンド: record-type-update

フラグ:

• value pos. 0 : 更新対象のレコードタイプのRecordTypeId

• value pos. 1 : 指定データでレコードタイプを更新する。シリアル化済みのJSON文字列が必要。

例:

My Vault> record-type-update 12345 "{\"$id\":\"myCustomType_dotnet_test6\",\"description\":\"My custom record\",\"categories\":[\"note\"],\"fields\":[{\"$ref\":\"login\"},{\"$ref\":\"password\"},{\"$ref\":\"url\"}]}" 
Updated Record Type ID: 12345

DotNet SDK

メソッド:

Task<string> UpdateRecordTypeAsync(string recordTypeId, string recordTypeData);

PowerCommander

コマンド: Edit-KeeperRecordType

フラグ:

• -RecordTypeId : カスタムレコードタイプのレコードID

• -Data : 更新が必要な追加フィールド

例:

PS > Edit-KeeperRecordType -RecordTypeId 12345 -Data '{"$id": "myCustomType","description": "My custom record with more fields","categories": ["note"],"fields": [{"$ref": "login"},{"$ref": "password"},{"$ref": "url"}]}'
Updated Record Type ID: 12345

Python CLI

コマンド : record-type-edit

パラメータ :

• record_type_id : 更新対象のレコードタイプのRecord Type ID。

• --data : DATA レコードタイプ定義をJSON形式で指定、またはJSONファイルから読む場合は file path: プレフィックス付きのパス。

例:

My Vault> record-type-edit 12345 --data "{\"$id\":\"myCustomType_python\",\"description\":\"M
y custom record\",\"categories\":[\"note\"],\"fields\":[{\"$ref\":\"login\"},{\"$ref\":\"pass
word\"},{\"$ref\":\"url\"}]}"
 
Custom record type (ID: 12345) updated successfully with fields: ['login', 'password', 'url'] and recordTypeId: 12345

Python SDK

関数: edit_custom_record_types

edit_custom_record_types(vault: vault_online.VaultOnline, record_type_id: int, title: str, fields: List[Dict[str, str]], description: str, categories: List[str] = None):

レコードタイプ削除コマンド

既存のカスタムレコードタイプを削除します。レコードタイプが存在すれば削除され、存在しなければその旨の通知のみになります。

DotNet CLI

コマンド: record-type-delete

フラグ:

• value pos. 0 必須。削除対象のレコードタイプのRecord Type Id

例:

My Vault> record-type-delete 12345
Deleted Record Type ID: 12345

DotNet SDK

メソッド:

Task<string> DeleteRecordTypeAsync(string recordTypeId);

PowerCommander

コマンド: Remove-KeeperRecordType

フラグ:

• -RecordTypeId : カスタムレコードタイプのレコードID

• -Confirm : 削除前の確認をPowerShellの標準どおりに行う

例:

PS > Remove-KeeperRecordType 12345 
Confirm
Are you sure you want to perform this action?
Performing the operation "Delete record type" on target "RecordTypeId '12345'".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"): A
Deleted Record Type ID: 12345

Python CLI

コマンド: record-type-delete

パラメータ:

• record_type_id : 削除対象のレコードタイプのRecord Type ID。

例:

My Vault> record-type-delete 12345
Custom record type deleted successfully with record type id: 12345

Python SDK

関数 : delete_custom_record_types

delete_custom_record_types(vault: vault_online.VaultOnline, record_type_id: int):