共有フォルダコマンド

共有フォルダ関連コマンドの説明

概要

共有フォルダの一覧やチームに関するコマンドをまとめ、詳細を記載しています。

1. 共有フォルダコマンド

2. 共有フォルダの一覧

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

コマンド

共有フォルダコマンド

共有フォルダへのアクセスをユーザーに付与または取り消すために使います。フォルダ内のユーザーおよびレコードの管理権限、ならびにそれらのレコードに対する共有権・編集権を与えられます。一定期間後、または指定日時で自動的に共有を終了するよう制限することもできます。

DotNet CLI

コマンド: sf-user

フラグ:

• --user : 共有の対象となるユーザーアカウントのメール、チーム名、またはチームUID。

• --delete (既定: false) : 共有フォルダから ユーザー または チーム を削除する

• -r, --manage-records : 「レコードの管理」権限の真偽値を設定する: ユーザーが レコードを管理できる 場合は true、共有フォルダから レコードの管理 権限を外す場合は false。

• -u, --manage-users : 「ユーザーの管理」権限の真偽値を設定する: ユーザーが ユーザーを管理できる 場合は true、共有フォルダから ユーザーの管理 権限を外す場合は false。

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

• --expire-in : 共有の相対期限: [N]mi|h|d|mo|y

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

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

• folder name (pos. 0) : 共有するフォルダ名。コマンドの直後の位置0に置く必須の位置引数

例:

My Vault> sf-user "Test-Example-folder/Example-shared-folder" --user "[email protected]" -r true -u true

DotNet SDK

メソッド:

public async Task PutUserToSharedFolder(string sharedFolderUid,
            string userId,
            UserType userType,
            IUserShareOptions options)

引数:

• sharedFolderUid: 共有フォルダのUID。

• userId: ユーザーまたはチームの userId。

• UserType: 種別は ユーザー または チーム。

• IUserShareOptions: 共有フォルダの権限を追加または削除する。オプションは次のとおり

  • Bool ManageRecords

  • Bool ManageUsers

  • DateTimeOffset Expiration

PowerCommander

コマンド: Grant-KeeperSharedFolderAccess

エイリアス: kshf

フラグ:

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

• -User または -Team : ユーザーのメールまたはチーム

• -ManageRecords : 権限

• -ManageUsers : 権限

例:

PS > Grant-KeeperSharedFolderAccess -SharedFolder shared_folder_uid -User "[email protected]" -ManageRecords
User "[email protected]" has been added to shared folder "Example Shared Folder" 

Python CLI

コマンド: share-folder

パラメーター (必須)

• -e, --email : アクセスを付与するユーザーのメールアドレス

• folder : 共有フォルダの <FOLDER_UID> またはパス

オプション:

• -a, --action : 付与または削除 - 共有フォルダに対する操作

• -s, --can-share : ユーザーがレコードを共有できるようにする

• -d, --can-edit : ユーザーがレコードを編集できるようにする

• -p, --manage-records : 共有フォルダ内のレコードを管理する権限を付与する

• -o, --manage-users : 共有フォルダのユーザーを管理する権限を付与する

• --expire-at : 共有の期限: "never" または ISO 日時 "YYYY-MM-DD hh:mm:ss"

• --expire-in : 共有の期限: "never" または期間 <NUMBER>[(m)inutes | (h)ours | (d)ays | (y)ears]

• --dry-run : 権限の変更内容を表示するだけで適用しない

• -f, --force : 既定のフォルダ権限を無視して権限変更を適用する

• -r, --record : <RECORD_UID>、レコード名、フォルダ内の全レコードは @existing

例:

My Vault> share-folder -a='grant' -e='[email protected]' -s='on' -d='on' -p='on' -o='on' --expire-in=30d shared_folder_uid
User share '[email protected]' added

Python SDK

sh_fol = vault.vault_data.load_shared_folder(shared_folder_uid)
if not sh_fol:
    return None
sf_uid = shared_folder_uid
sf_entity = vault.vault_data.storage.shared_folders.get_entity(sf_uid)
shared_folder_revision = sf_entity.revision if sf_entity else 0
sf_unencrypted_key = vault.vault_data.get_shared_folder_key(shared_folder_uid=sf_uid)
if not sf_unencrypted_key:
    return None
sf_info = {
    "shared_folder_uid": sf_uid,
    "users": sh_fol.user_permissions,
    "teams": [],
    "records": [{"record_uid": r.record_uid} for r in sh_fol.record_permissions],
    "shared_folder_key_unencrypted": sf_unencrypted_key,
    "default_manage_users": sh_fol.default_manage_users,
    "default_manage_records": sh_fol.default_manage_records,
    "revision": shared_folder_revision,
}
request = shares_management.FolderShares.prepare_request(
    vault=vault,
    kwargs={
        "action": shares_management.ShareAction.GRANT.value,  # 'grant' to share, 'remove' to unshare
        "manage_records": shares_management.ManagePermission.ON.value if manage_records else shares_management.ManagePermission.OFF.value,  # Allow managing records
        "manage_users": shares_management.ManagePermission.ON.value if manage_users else shares_management.ManagePermission.OFF.value,      # Allow managing users/teams
        "can_edit": shares_management.ManagePermission.ON.value if can_edit else shares_management.ManagePermission.OFF.value,              # Allow editing records
        "can_share": shares_management.ManagePermission.ON.value if can_share else shares_management.ManagePermission.OFF.value,            # Allow sharing records
    },
    curr_sf=sf_info,
    users=users,
    teams=teams,
    rec_uids=record_uids or [],
    default_record=default_record,
    default_account=default_account,
    share_expiration=share_expiration,
)

partitioned_requests = [[request]]
shares_management.FolderShares.send_requests(vault, partitioned_requests)

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

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

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;

PowerCommander

コマンド: Get-KeeperSharedFolder

フラグ:

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

• -Filter : 共有フォルダを絞り込むために使う。

例:

PS> Get-KeeperSharedFolder

Uid                    Name                            DefaultManageRecords DefaultManageUsers DefaultCanEdit DefaultCanShare UserCount RecordCount
---                    ----                            -------------------- ------------------ -------------- --------------- --------- -----------
shared_folder_uid      example_new_shared_folder       True                 True               True           True                    1           1

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 : 詳細出力

例:

My Vault> list-sf
  #  Shared Folder UID       Name
---  ----------------------  -----------------------------------------
  1  shared_folder_uid       Test Example Folder

Python SDK

関数: find_shared_folders

find_shared_folders(self, criteria: str) -> Iterable[vault_types.SharedFolderInfo]

例:

shared_folders = vault.vault_data.find_shared_folders(criteria=pattern)

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

共有フォルダ内のレコードに対する権限を変更できます。必要に応じて個々のレコードに対して権限の付与または取り消しができます。

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:mm:SS

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

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

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

• folder name (pos. 0) : 必須。フォルダ名

例:

My Vault> sf-record record_uid
  #  Record Title   Record UID              Can Edit  Can Share  Expiration
---  -------------  ----------------------  --------  ---------  ----------
  1  ABC            record_uid              X         X
  2  Gmail Account  record_uid              X         X
  3  Gmail Account  record_uid              X         X

My Vault> sf-record folder_uid --record=record_uid --expire-in=30mi

My Vault> sf-record BRvqCEzmFM9rVqkmpeGs6A
  #  Record Title   Record UID              Can Edit  Can Share  Expiration
---  -------------  ----------------------  --------  ---------  ----------------
  1  ABC            record_uid              X         X          03-11-2025 18:08
  2  Gmail Account  record_uid              X         X
  3  Gmail Account  record_uid              X         X

DotNet SDK

メソッド: ChangeRecordInSharedFolder

public async Task ChangeRecordInSharedFolder(string sharedFolderUid, string recordUid, IRecordShareOptions options)

例:

await context.Vault.ChangeRecordInSharedFolder(sf.Uid, recordUid, shareOptions);

PowerCommander

共有フォルダにユーザーまたはチームを追加または削除する。

コマンド: Grant-KeeperSharedFolderAccess

エイリアス: kshf

使い方:

Grant-KeeperSharedFolderAccess -SharedFolder <string> -User <string> [-ManageRecords] [-ManageUsers] [<CommonParameters>]
# チームを追加
Grant-KeeperSharedFolderAccess -SharedFolder <string> -Team <string> [-ManageRecords] [-ManageUsers] [<CommonParameters>]

パラメーター

パラメーター	説明
-SharedFolder	共有フォルダのUID、名前、または Uid プロパティを持つオブジェクト。
-User	共有フォルダに追加するユーザーのメールアドレス。ユーザーを追加するときに必須。
-Team	追加するチームを表す文字列 (チーム名またはUID)。

Revoke-KeeperSharedFolderAccess

共有フォルダからユーザーまたはチームを削除する。その共有フォルダ内のすべてのレコードへのアクセスが失われる。

エイリアス: kushf

使い方

Revoke-KeeperSharedFolderAccess -SharedFolder <UID or name> -User <email>

パラメーター

パラメーター	型	必須	説明
SharedFolder	string またはオブジェクト	はい	共有フォルダのUID、名前、または Uid プロパティを持つ任意のオブジェクト。
User	string	はい*	共有フォルダから削除するユーザーのメールアドレス。-Team を使わないときは必須。
Team	string	はい*	共有フォルダから削除するチーム名またはUID。-User を使わないときは必須。

-User または -Team のどちらか一方を指定する必要がある。

例

ユーザーを共有フォルダから削除

Revoke-KeeperSharedFolderAccess -SharedFolder "Support SF" -User "[email protected]"

共有フォルダUIDを指定:

Revoke-KeeperSharedFolderAccess -SharedFolder "abc123XYZ" -User "[email protected]"

チームを共有フォルダから削除

Revoke-KeeperSharedFolderAccess -SharedFolder "Support SF" -Team "Contractors"

エイリアスを使う

kushf -SharedFolder "Finance" -User "[email protected]"

出力

成功時には確認メッセージが表示される。例:

User "[email protected]" has been removed from shared folder "Support SF"

または

Team "Contractors" has been removed from shared folder "Support SF"

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 のいずれかが必須

• 例:

My Vault> record-permission -a grant --share-record -s -d shared_folder_uid

Request to GRANT "Can Edit" & "Can Share" permission(s) in "my_share" folder only

Python SDK

コマンド: 近日対応