Python SDK
Keeperシークレットマネージャー向けPython SDKの詳細情報
最終更新
Keeperシークレットマネージャー向けPython SDKの詳細情報
最終更新
Pythonのソースコードは、で入手できます。
パラメータ
必須
説明
型
token
はい
ワンタイムアクセストークン
String
config
はい
ストレージの設定
KeyValueStorage
パラメータ
型
必須
デフォルト
説明
uids
String[]
オプション
None
取得するUIDレコード
戻り値
型: Record[]
Keeperのすべてのレコード、または指定されたUIDを持つレコード。
Keeperシークレットマネージャーからシークレットを取得すると、このショートカットでそのシークレットのパスワードを取得します。
パラメータ
型
必須
デフォルト
説明
field_type
String
はい
取得するフィールドタイプ
single
boolean
オプション
False
最初の値のみを返す
value
String
またはString[]
オプション
None
指定すると、フィールドの値を指定値に設定
パラメータ
型
必須
デフォルト
説明
label
String
はい
カスタムフィールドのラベル
field_type
String
はい
取得するフィールドタイプ
single
boolean
オプション
False
最初の値のみを返す
value
String
またはString[]
オプション
None
指定すると、フィールドの値を指定値に設定
同じカスタムタイプの複数のフィールドを1つのレコードに表示することができます。これらのフィールドを区別するには、フィールドラベルが必要です。
戻り値
型: String
またはString[]
フィールドの1つまたは複数の値。 single=True
オプションを指定した場合のみ、単一の値になります。
record_title
String
はい
検索するレコードタイトル
パラメータ
型
必須
デフォルト
説明
query
String
はい
指定したフィールドの値を取得するためのKeeper表記法を使用したクエリ
型: string
or string[]
照会したフィールドの値
パラメータ
型
必須
デフォルト
説明
url
String
はい
TOTP Url
レコード更新コマンドは、成功時にローカルのレコードデータ (特にレコードリビジョンの更新) を更新しないため、既に更新されたレコードを継続的に更新してもリビジョンの不一致により失敗となります。各更新バッチの後に、更新済みのレコードをすべてリロードするようにしてください。
変更をシークレットに保存
record
KeeperRecord
はい
ストレージとクエリの設定
複数の値を持つフィールドもあります。このような場合は、値をリストに設定できます。
パラメータ
型
必須
デフォルト
説明
field_type
String
はい
取得するフィールドタイプ
single
boolean
オプション
False
最初の値のみを返す
value
String
またはString[]
オプション
None
指定すると、フィールドの値を指定値に設定
パラメータ
型
必須
デフォルト
説明
label
String
はい
カスタムフィールドのラベル
field_type
String
はい
取得するフィールドタイプ
single
boolean
オプション
False
最初の値のみを返す
value
String
またはString[]
オプション
None
指定すると、フィールドの値を指定値に設定
length
int
オプション
64
lowercase
int
オプション
0
uppercase
int
オプション
0
digits
int
オプション
0
specialCharacters
int
オプション
0
各パラメータは、使用する文字の種類の最小数を示します。たとえば、「uppercase」は、使用する大文字の最小数となります。
パラメータ
型
必須
デフォルト
説明
file_path
String
はい
ファイルの保存先のパス
create_folders
boolean
いいえ
False
存在しない場合はfile_pathにフォルダを作成
ファイルのアップロード
Keeperファイルアップロードオブジェクトを作成
ファイルのアップロード
owner_record
KeeperRecord
はい
アップロードされたファイルを添付するレコード
file
KeeperFileUpload
はい
アップロードするファイル
ファイルからのKeeperファイルのアップロード
path
string
はい
アップロードするファイルへのパス
file_name
string
いいえ
None
アップロード後にKeeperに格納されるファイルの名前
file_title
string
いいえ
None
アップロード後にKeeperに格納されるファイルのタイトル
mime_type
string
いいえ
None
ファイル内のデータの種類。 何も指定しない場合は、「application/octet-stream」が使用されます。
型: string
添付ファイルのファイルUID
共有フォルダのUID
共有フォルダには、シークレットマネージャーアプリケーションからアクセスできる必要があります。
あなたとシークレットマネージャーアプリケーションには編集権限が必要です。
共有フォルダには、少なくとも1つのレコードが存在する必要があります。
作成されたレコードとレコードのフィールドは正しく書式設定されている必要があります。
TOTPフィールドには、KSM SDK以外で生成されたURLのみを指定できます。
folder_uid
String
はい
record
KeeperRecord
はい
型: string
新規レコードのレコードUID
Python KSM SDKでKeeperボルトのレコードを削除できます。
record_uid
string
はい
ネットワークアクセスが失われたときにシークレットにアクセスできなる状況を避けるため、Python SDKを使用してシークレットを暗号化されたファイルでローカルマシンにキャッシュできます。
キャッシュの設定と構成
Python SDKでキャッシュを設定するには、SecretsManager
オブジェクトを作成するときにキャッシュポスト関数を含める必要があります。
Python SDKには、KSMCache
クラスにデフォルトのキャッシュ機能が含まれており、キャッシュされたクエリをローカルファイルに保存し、復旧機能として使用できます (ネットワーク接続がある場合は常にネットワークデータを優先し、ウェブボルトにアクセスできない場合にのみキャッシュを使用します)。独自のキャッシュ機能を作成することも可能で、KSMCache
を出発点として利用できます。例えば、ネットワークアクセスよりもローカルキャッシュを優先し、独自のキャッシュ管理を行う (例:キャッシュデータを5分ごとに更新する) 機能を作成できます。
KSMCache
クラスのデフォルトキャッシュ機能は、常に最後のリクエストのみを保存します。例えば、UID1に対するフィルタリングリクエストがキャッシュされている場合、ネットワーク切断時に同じキャッシュからUID2をリクエストすると、空のレスポンスが返されます (UID2が同じKSMアプリに共有されている場合でも、それがキャッシュされていなければ利用できません)。
キャッシュからのレコード更新 (または新しいレコードの作成) は、キャッシュされたレコードデータを無効にし、同じレコードを連続して更新する操作は失敗します。異なるレコードを修正する場合、バッチ更新は機能します。キャッシュされたレコードを更新した後は、常に get_secrets
関数を呼び出してキャッシュをリフレッシュし、ボルトから新しいレコードリビジョンなどの更新されたメタデータを取得するようにしてください。
フォルダは完全なCRUD (作成、読み取り、更新、削除操作) をサポートしています。
フォルダの完全な階層構造をダウンロードします。
レスポンス
型: List[KeeperFolder]
使用例
CreateOptions
とフォルダ名の指定が必要です。CreateOptions
はフォルダのUIDパラメータ (共有フォルダのUID) が必須ですが、サブフォルダのUIDはオプションであり、指定されていない場合は、通常の新しいフォルダが親 (共有フォルダ) の直下に作成されます。サブフォルダは、親の共有フォルダの直接の下位オブジェクトである必要はありません。親フォルダから何階層も深い位置にサブフォルダを作成することができます。
create_options
CreateOptions
はい
親およびサブフォルダのUID
folder_name
str
はい
フォルダ名
folders
List[KeeperFolder]
いいえ
None
CreateOptionsで作成した親とサブフォルダの検索に使用するフォルダのリスト
使用例
フォルダのメタデータ (現在はフォルダ名のみ) を更新します。
folder_uid
str
はい
フォルダのUID
folder_name
str
はい
新しいフォルダ名
folders
List[KeeperFolder]
いいえ
None
親フォルダの検索に使用するフォルダのリスト
使用例
フォルダのリストを削除します。空でないフォルダを削除するには、force_deletion
フラグを使用します。
folder_uids
List[str]
はい
フォルダUIDリスト
force_deletion
bool
いいえ
False
空でないフォルダを強制的に削除
使用例
カスタムフィールドは、レコードタイプ定義の一部ではありませんが、ユーザーが追加できるフィールドです。 各標準レコードタイプのフィールドの一覧は、をご参照ください。
Keeper表記法の形式と機能については、をご参照ください。
メソッドを使用してフィールド値を設定します。
レコードタイプごとの適切なフィールド形式については、をご参照ください。
レコードの作成後は、を使用して添付ファイルをアップロードできます。
フィールドはタイプで検索されます。フィールドタイプの一覧については、レコードタイプのページをご参照ください。
フィールドはタイプで検索されます。フィールドタイプの一覧については、レコードタイプのページをご参照ください。
フィールドはタイプで検索されます。フィールドタイプの一覧については、レコードタイプのページをご参照ください。