フィールド/レコードタイプ

シークレットマネージャーで使用できるフィールドタイプとレコードタイプ

フィールドタイプ

フィールドタイプは、フィールドのデータがどのように保存されるかを定義します。フィールドタイプは、デフォルトのレコードタイプおよびユーザーが作成したカスタムレコードで使用されます。

各フィールドタイプには、適切な形式でデータを設定してください。SDKでは、デフォルトでは多くのフィールドに対して厳密な入力チェックは行われません。そのため、フィールドに応じた正しい形式でデータを設定することがベストプラクティスとされています。

また、Keeperが提供する他の製品では、フィールドタイプに基づいてレコードからデータを取得するため、正しいフィールド形式を使用することが重要です。

accountNumber

文字列型の値です。値に対する検証は行われません。

address

以下の要素を含む辞書型の値です。

• street1 - 住所1
• street2 - 住所2
• city - 市
• state - 州
• zip - 郵便番号
• counrty - ISO3166 Alpha-2形式の国コード

いずれのキーも必須ではありません。

例

{"street1":"100 Main Street", "city":"Town", "state":"RI", "zip":"55555",
    "country":"US"}

bankAccount

以下の要素を含む辞書型の値です。

• accountType - 口座種別 (Checking / Savings / Other)
• otherType - その他の口座種別の説明
• routingNumber - 銀行のルーティング番号
• accountNumber - 口座番号

いずれのキーも必須ではありません。

例

{"accountType":"Checking", "routingNumber":"123456", "accountNumber":"55555555"}

birthDate

エポックミリ秒形式の値です。作成方法 (例: ヘルパーモジュールを使用する場合) によっては、ISO8601形式の値を指定できます。ISO8601形式の値は、自動的にエポックミリ秒の値へ変換されます。

cardRef

クレジットカードのレコードUIDの配列です。

例

["OlLZ6JLjnyMOS3CiIPHBjw", "XJ2VISBJ3JAeCwU_YGAXYg"]

date

エポックミリ秒形式の値です。作成方法 (例: ヘルパーモジュールを使用する場合) によっては、ISO8601形式の値を使用できます。ISO8601形式の値は、エポックミリ秒形式に変換されます。

email

文字列型の値で、通常はユーザーのメールアドレスを指定します。値に対する検証は行われません。

expirationDate

エポックミリ秒形式の値です。作成方法 (例: ヘルパーモジュールを使用する場合) によっては、ISO8601形式の値を使用できます。ISO8601形式の値は、エポックミリ秒形式に変換されます。

fileRef

ファイルUIDの配列です。レコードにファイルが添付されると、そのファイルのUIDがこの配列に追加されます。

host

以下の要素を含む辞書型の値です。

• hostName - ホスト名またはIPアドレス
• port - 接続先のポート番号

いずれのキーも必須ではありません。

例

{"hostName": "localhost", "port":"22"}

以下の要素を含む辞書型の値です。

• publicKey - 公開鍵
• privateKey - 秘密鍵

いずれのキーも必須ではありません。

例

{"publicKey":"PUBLIC KEY", "privateKey":"PRIVATE KEY"}

licenseNumber

文字列型の値です。値に対する検証は行われません。

login

文字列型の値で、通常はユーザーのログイン名を指定します。値に対する検証は行われません。多くのKeeper関連サービスでは、ログイン情報としてこのフィールドタイプが参照されます。

multiline

文字列型の値で、通常は改行を含むテキストに使用されます。値に対する検証は行われません。

name

以下の要素を含む辞書型の値です。

• first - ファーストネーム
• middle - ミドルネーム
• last - ラストネーム

いずれのキーも必須ではありません。

例

{"first":"John", "middle":"Unknown", "last":"Smith"}

note

複数行の入力に対応した文字列型の値です。値はマスク表示されます。値に対する検証は行われません。

otp

TOTP用のワンタイムパスワードURLです。

oneTimeCode

TOTP用のワンタイムコードURLです。

password

文字列型の値です。値に対する検証は行われません。多くのKeeper関連サービスでは、パスワードの値としてこのフィールドタイプが参照されます。

paymentCard

以下の要素を含む辞書型の値です。

• cardNumber - クレジットカード番号
• cardExpirationDate - MM/YYYY形式での有効期限
• cardSecurityCode - セキュリティコード

例

{"cardNumber":"5555 5555 5555 5555", "cardExpirationDate":"01/2023",
    "cardSecurityCode":"123"}

phone

電話番号情報を含む辞書の配列です。各電話番号の辞書には、以下のキーと値が含まれます。

• region - 国番号
• number - 電話番号
• ext - 内線番号
• type - 電話番号の種別 (Mobile | Home | Work)

いずれのキーも必須ではありません。

例

[
    {"region": "+1", "number":"555-555-5555", "ext":"1234", "type":"Work"},
    {"number":"555-555-6666", "type":"Mobile"}
]

pinCode

文字列型の値です。値に対する検証は行われません。

secret

文字列型の値です。このタイプのフィールドは通常マスク表示されます。値に対する検証は行われません。

securityQuestion

以下の要素を含む辞書型の値です。

• question - 秘密の質問
• answer - 秘密の質問への回答

例

{"question":"What Number?", "answer":"42"}

text

文字列型の値です。値に対する検証は行われません。

url

文字列型の値で、通常はウェブURLを指定します。値に対する検証は行われません。

デフォルトのレコードタイプ

以下は、Keeperにあらかじめ用意されているデフォルトのレコードタイプと、それぞれのレコードタイプに含まれるフィールドの一覧です。レコードタイプには、標準フィールドとして使用される複数のフィールドタイプが定義されています。なお、カスタムフィールドはレコードタイプによって定義されるものではありません。

すべてのデフォルトレコードタイプには、fileRef フィールドが含まれています。このフィールドには、レコードに添付されたファイルのUIDおよび写真のUIDが含まれます。ファイルのダウンロード方法については、使用しているSDKのドキュメントを参照してください。

なお、現時点ではSDKを使用したファイルの添付には制限があります。

address (住所)

フィールドタイプ	UIフィールド
address	住所1 住所2 市 県 郵便番号 国

bankAccount (銀行口座)

フィールドタイプ	UIフィールド
bankAccount	口座種別 その他の種類 口座番号 ルーティング番号
name	ファーストネーム ミドルネーム ラストネーム
login	ログイン
password	パスワード
url	ウェブサイトのアドレス
cardRef (値はbankCardのUIDレコード)	クレジットカード

bankCard (クレジットカード)

フィールドタイプ	UIフィールド
paymentCard	カード番号 有効期限の月 有効期限の年 セキュリティコード
text	カードの所有者名
pinCode	暗証番号
addressRef (値は住所のUIDレコード)	住所 (UIについてはaddressのレコードタイプを参照)

birthCertificate (出生証明書)

• name - ファーストネーム、ミドルネーム、ラストネーム
• birthDate - 生年月日

フィールドタイプ	UIフィールド
name	ファーストネーム ミドルネーム ラストネーム
birthDate	生年月日

contact (連絡先)

フィールドタイプ	UIフィールド
name	ファーストネーム ミドルネーム ラストネーム
text	会社名
email	メール
phone	国 電話番号 内線番号 種別
addressRef (値は住所のUIDレコード)	住所 (UIについてはaddressのレコードタイプを参照)

databaseCredentials (データベース)

フィールドタイプ	UIフィールド
text	種別
host	ホスト名またはIPアドレス ポート
login	ログイン
password	パスワード

driverLicense (運転免許証)

フィールドタイプ	UIフィールド
accountNumber	運転免許番号
name	ファーストネーム ミドルネーム ラストネーム
birthDate	生年月日
addressRef (値は住所のUIDレコード)	住所 (UIについてはaddressのレコードタイプを参照)
expirationDate	有効期限

encryptedNotes (セキュアノート)

フィールドタイプ	UIフィールド
note	メモ
date	日付

file (添付ファイル)

このレコードは、別のレコードにファイルが添付された際に作成されます。作成されたレコードのUIDは、fileRef フィールドタイプを通じて対象のレコードに関連付けられます。

なお、現時点では、すべてのSDKにおいてレコードへのファイル添付機能は未完了です。今後、内容が追加される予定です。

healthInsurance (健康保険)

accountNumber	口座番号
name	ファーストネーム ミドルネーム ラストネーム
login	ログイン
password	パスワード
url	ウェブサイトアドレス

login (ログイン)

フィールドタイプ	UIフィールド
login	ログイン
password	パスワード
url	ウェブサイトアドレス

membership (メンバーシップ)

フィールドタイプ	UIフィールド
accountNumber	口座番号
name	ファーストネーム ミドルネーム ラストネーム
password	パスワード

passport (パスポート)

フィールドタイプ	UIフィールド
accountNumber	パスポート番号
name	ファーストネーム ミドルネーム ラストネーム
birthDate	生年月日
addressRef (値は住所のUIDレコード)	住所 (UIについてはaddressのレコードタイプを参照)
expirationDate	有効期限
date	発行日
password	パスワード

photo (画像)

このレコードは、画像が別のレコードに添付されたときに作成されます。UIDレコードは、fieldRefフィールドタイプを使用してレコードに添付されます。

現在、すべてのSDKでレコードへの画像添付は完了していません。コンテンツは追加予定です。

serverCredentials (サーバー)

フィールドタイプ	UIフィールド
host	ホスト名またはIPアドレス ポート
login	ログイン
password	パスワード

softwareLicense (ソフトウェアライセンス)

フィールドタイプ	UIフィールド
licenseNumber	ソフトウェアライセンスキー
expirationDate	有効期限
date	有効化した日

ssnCard (IDカード)

フィールドタイプ	UIフィールド
accountNumber	ID番号
name	ファーストネーム ミドルネーム ラストネーム

sshKeys (SSH鍵)

フィールドタイプ	UIフィールド
login	ログイン
keyPair	公開鍵 秘密鍵
password	パスフレーズ
host	ホスト名またはIPアドレス ポート

カスタムのレコードタイプ

カスタムレコードタイプは、シークレットマネージャーで使用できます。

カスタムレコードタイプのスキーマは、Keeperコマンダーを使用して取得できます。

My Vault> rti --format json -lr "My Custom" --output my_record_type.json
[
  {
    "recordTypeId":18,
    "content": "{\"$id\":\"My Custom\",\"categories\":[\"login\"],
        \"description\":\"SSH key template\",\"fields\":
           [{\"$ref\":\"login\"},
            {\"$ref\":\"keyPair\"},
            {\"$ref\":\"password\",\"label\":\"passphrase\"},
            {\"$ref\":\"host\"},
            {\"$ref\":\"fileRef\"}]}"
  }
]

使用しているSDKに基づいて、JSONをインポートし、任意のヘルパーツールでカスタムのレコードを使用できます。