For the complete documentation index, see llms.txt. This page is also available as Markdown.

共有フォルダコマンド

共有フォルダ一覧およびレコード権限変更コマンドの説明

概要

共有フォルダの一覧、チーム、ならびにレコード権限の変更に関するコマンドを整理し、詳細を記載しています。

コマンド

共有フォルダ一覧コマンド

指定したフォルダ内、またはKeeperボルトの現在のディレクトリにある共有フォルダを一覧表示します。

DotNet CLI

コマンド: sf-list

例:

My Vault> sf-list
  #  Shared Folder UID       Name                             # Records  # Users
---  ----------------------  -------------------------------  ---------  -------
  1  shared_folder_uid       Test-Shared-Folder                11         1      
DotNet SDK

関数:

var sharedFolders = vault.SharedFolders;
Power Commander

コマンド: Get-KeeperSharedFolder

フラグ:

  • -Uid : 共有フォルダのUID

  • -Filter : 共有フォルダを絞り込むために使用する

例:

Python CLI

コマンド: list-sf

オプション:

  • pattern : 共有フォルダのタイトルまたはUIDのパターン

  • -h, --help : このヘルプを表示して終了する

  • --format : list-sf コマンドの出力形式を指定する。指定できる値は以下のとおり。

    • table: 表形式で出力する。既定では表形式

      • 例: --format table

    • csv: CSV形式で出力する

      • 例: --format csv

    • json : JSON形式で出力する

      • 例: --format json

  • --output : 出力をファイルに保存する。出力形式が table (--format table) のときは使用しない

    • 例: --output <file_name>

  • --verbose, -v : 詳細出力

例:

Python SDK

関数: find_shared_folders

例:

共有フォルダコマンド

従来型の共有フォルダの共有権限を変更します。ユーザー、チーム、レコードへのアクセスを許可または削除する際に使用します。

備考:

  • 従来型の共有フォルダにのみ対応。NSFやKeeper Driveの階層型フォルダには対応していません

  • 招待: ユーザーがKeeperアカウントを持っていない場合、SDKが招待を送信します。相手が招待を承諾したら、再度共有してください

  • チャンク処理: CLIは大量のユーザー・レコードを1バッチあたり 999 件ずつに分割します。SDKの send_requests 呼び出しも、APIコール1回あたり 999 リクエストずつに分割します

Python CLI

コマンド: share-folder [options] <folder> [<folder> ...]

別名: sf

位置パラメータ:

  • folder: 必須。1件以上の共有フォルダのパス、名前、またはUIDを指定します。* を指定すると、ボルト内のすべての共有フォルダが対象になります

アクション:

  • -a, --action: grant または remove。既定は grant

    • grant: アクセスを追加または更新します

    • remove: ユーザー、チーム、またはレコードのアクセスを取り消します

ユーザーとチーム:

  • -e, --email: 繰り返し指定可。以下を指定できます:

    • user@example.com: ユーザーへのアクセスを許可または取り消します

    • <team_name> または <team_uid>: チームへのアクセスを許可または取り消します

    • @existing または @current: フォルダに既に存在するすべてのユーザーとチームを対象にします

    • *: フォルダの既定のアカウント権限を更新します

レコード:

  • -r, --record: 繰り返し指定可。以下を指定できます:

    • レコードのタイトルまたはUID

    • @existing または @current: フォルダ内のすべてのレコードを対象にします

    • *: 既定のレコード権限を更新します

アカウント権限:

  • -p, --manage-records: on または off。ユーザーまたはチームがフォルダ内のレコードを追加・削除・編集できるようにします

  • -o, --manage-users: on または off。ユーザーまたはチームが他のユーザーやチームを追加・削除できるようにします

レコード権限:

  • -d, --can-edit: on または off。共有レコードの編集を許可します

  • -s, --can-share: on または off。共有レコードの再共有を許可します

有効期限:

  • --expire-at: never、または yyyy-MM-dd か yyyy-MM-dd hh:mm:ss 形式のISO日時

  • --expire-in: never、または <N>[(y)ears|(mo)nths|(d)ays|(h)ours|(mi)nutes]

  • 有効期限は --action grant の場合にのみ適用されます

  • 省略した場合、共有に有効期限は設定されません

失効時のローテーション:

  • -roe, --rotate-on-expiration: 共有アクセスが失効した時点で pamUser のパスワードをローテーションします

その他:

  • -f, --force: コマンドには定義されていますが、初回共有時に既定のフォルダ権限を無視するためのもので、現行のSDK CLI実行ロジックには組み込まれていません

例:

Python SDK

例:

JavaScript SDK

関数: listSharedFolders

共有フォルダ - レコード権限の変更コマンド

共有フォルダ内のレコード権限を変更します。レコードごとに付与または取り消しが可能です。

DotNet CLI

コマンド: sf-record

フラグ:

  • -r, --record : 共有フォルダ内で共有の対象とするレコード名またはレコードUID

  • -s, --can-share : 真偽値 (true または false)。true のとき共有権限あり。false のとき共有権限が削除されます

  • -e, --can-edit : 真偽値 (true または false)。true のとき編集権限あり。false のとき編集権限が削除されます

  • --expire-at : 共有の期限をISO時刻で指定: YYYY-MM-DD HH🇲🇲SS

  • --expire-in : 共有の相対期限: [N]mi|h|d|mo (分 / 時間 / 日 / 月)

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

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

  • folder name (pos. 0) : 必須の共有フォルダ名 (位置引数 0)

例:

DotNet SDK

メソッド: ChangeRecordInSharedFolder

例:

Power Commander

コマンド: Set-KeeperSharedFolderRecordPermission

別名: ksfr

フラグ:

  • -SharedFolder : 共有フォルダのUID、名前、またはUID/名前を含むオブジェクト

  • -Record : レコードUID、またはレコードUIDを含むオブジェクト

  • -CanEdit : 共有フォルダのメンバーがレコードを編集できるかどうか。true、false、1、0 のいずれかを指定します

  • -CanShare : 共有フォルダのメンバーがレコードを再共有できるかどうか。true、false、1、0 のいずれかを指定します

  • -ExpireIn : 30d や 1h のように、現在時刻からの相対的な期限を設定します

  • -ExpireAt : 絶対的な期限日時を設定します

  • -RotateOnExpiration : 権限が失効したときにレコードのパスワードをローテーションします。期限の設定に加え、pamUser ローテーションレコードが構成された共有フォルダが必要です

  • -WhatIf : 変更を加えずに、権限変更の内容をプレビューします

  • -Confirm : 権限変更の前に確認を求めます

例:

Python CLI

コマンド: record-permission

パラメーター:

  • -a, --action 付与または取り消し (必須)

  • folder 変更を適用する共有フォルダのUID (必須)

オプション:

  • --dry-run コミットせずに権限の変更内容を表示する

  • --force 確認なしで権限変更を適用する

  • -R, --recursive すべてのサブフォルダに権限変更を適用する

  • --share-record レコードの共有権限を変更する

  • --share-folder フォルダの共有権限を変更する

  • -s, --can-share レコード権限: 共有可能にする

  • -d, --can-edit レコード権限: 編集可能にする

    • --can-edit または --can-share のいずれかが必須

  • 例:

Python SDK

関数:

共有フォルダへのユーザーまたはチームの追加コマンド

指定したアクセス権限で、共有フォルダにユーザーまたはチームを追加します。

DotNet CLI

コマンド: 近日公開

DotNet SDK

関数:

Power Commander

コマンド: Grant-KeeperSharedFolderAccess -SharedFolder <String> [-User <String>] [-Team <String>] [-ManageUsers <Boolean>] [-ManageRecords <Boolean>] [-TransferRecords <Boolean>] [-AllowShareFullVault <Boolean>] [-WhatIf] [-Confirm]

フラグ:

  • -SharedFolder : アクセスを許可する共有フォルダのUIDまたは名前

  • -User : アクセスを許可するユーザーのメールアドレスまたはUID。-User または -Team のいずれかを指定する必要があります

  • -Team : アクセスを許可するチームのUIDまたは名前。-User または -Team のいずれかを指定する必要があります

  • -ManageUsers : 共有フォルダ内のユーザーを管理する権限を付与します

  • -ManageRecords : 共有フォルダ内のレコードを管理する権限を付与します

  • -TransferRecords : 共有フォルダ内でレコードの所有権を移管する権限を付与します

  • -AllowShareFullVault : 共有フォルダ内だけでなく、ボルト全体からレコードを共有する権限を付与します

  • -WhatIf : 実際には実行せずに、コマンドレット実行時の動作をプレビューします

  • -Confirm : コマンドレットの実行前に確認を求めます

例:

Python CLI

コマンド: 近日公開

Python SDK

関数: 近日公開

共有フォルダからのユーザーまたはチームの削除コマンド

共有フォルダからユーザーまたはチームを削除します。

DotNet CLI

コマンド: 近日公開

DotNet SDK

関数:

Power Commander

コマンド: Revoke-KeeperSharedFolderAccess -SharedFolder <String> [-User <String>] [-Team <String>] [-Force] [-WhatIf] [-Confirm]

フラグ:

  • -SharedFolder : アクセスを許可する共有フォルダのUIDまたは名前

  • -User : アクセスを許可するユーザーのメールアドレスまたはUID。-User または -Team のいずれかを指定する必要があります

  • -Team : アクセスを許可するチームのUIDまたは名前。-User または -Team のいずれかを指定する必要があります

  • -Force : 確認プロンプトなしでアクセスを取り消します

  • -WhatIf : 実際には実行せずに、コマンドレット実行時の動作をプレビューします

  • -Confirm : コマンドレットの実行前に確認を求めます

例:

Python CLI

コマンド: 近日公開

Python SDK

関数: 近日公開

JavaScript SDK

関数: shareFolder

最終更新