共有コマンド

レコードおよび共有フォルダの共有に関するコマンドの説明

概要

ユーザーへの共有に関して使うコマンドの一覧です。

1. Share Recordコマンド

2. Share Folderコマンド

3. One Time Share Listコマンド

4. One Time Share Createコマンド

5. One Time Share Removeコマンド

Share Folderコマンド

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

DotNet CLI

コマンド: sf-user

フラグ :

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

• --delete (Default: 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 : ユーザーの種類。User または Team。

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

  • Bool ManageRecords

  • Bool ManageUsers

  • DateTimeOffset Expiration

Power Commander

コマンド: 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)

One Time Share Createコマンド

ボルト内のレコードの共有リンクを作成し、外部のユーザーに認証情報やレコード情報を共有するために使います。リンクは1台のデバイス/ブラウザでのみ開け、そのデバイス/ブラウザではリンクの有効期限まで再び開ける、という動作になります。

DotNet CLI

コマンド: one-time-share

フラグ:

• --client : ワンタイム共有のアクション名 create 。コマンド直後の位置0の必須の位置引数。

• --expire : 共有の失効までの期間 [(m)inutes|(h)ours|(d)ays。create 引数と併用する。

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

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

• value pos. 0 : 実行するアクションを指定する必須の位置引数。コマンド直後の位置0に置く。受け付ける値は次のとおり。

  • create – 新しいワンタイム共有を作成する

• value (pos. 1) : 必須。共有するレコードのUIDまたはパス。コマンド直後の位置1に置く位置引数。

例:

My Vault > one-time-share create record_uid --expire 2m
URL: https://keepersecurity.com:443/vault/share#asdfsadf

DotNet SDK

メソッド:

public static async Task<string> CreateExternalRecordShare(this VaultOnline vault, 
        string recordUid, 
        TimeSpan expireIn, 
        string shareName = null)

引数:

• vault : ボルトコンテキストで使用する。

vault.CreateExternalRecordShare(record.Uid, TimeSpan expireIn)

• recordUid : 共有するレコードのUid。

• TimeSpan : レコードの有効期限を設定するTimeSpanクラスのオブジェクト。

• shareName : ワンタイム共有の名前。

Power Commander

コマンド: New-KeeperOneTimeShare

別名: kotsn

フラグ:

• -Uid : レコードのUid

• -ExpireIn : ワンタイム共有の失効までの時間 (分)

• -ExpireAt : ワンタイム共有の失効日時 (日付形式)

• -ShareName : ワンタイム共有のレコード名

例:

PS > New-KeeperOneTimeShare -Uid record_uid -ExpireIn 5 -ShareName "Example Share" 
https://keepersecurity.com:443/vault/share#qwertyuiopasdfghjklzxcvbnm

Python CLI

コマンド: share-create

パラメータ:

• record : 共有URLを作成する対象の <RECORD_UID> またはパス

• -e, --expire : 共有URLの有効期限。経過後はリンクは無効。設定できる最大期間は6ヶ月または182日

オプション:

• --name : 共有URLの名前

• --editable : 共有レコードの編集を許可する

• --output : 共有URLの出力先 (クリップボードまたはコンソール/標準出力)

例:

My Vault> share-create --name='share_record' -e=30d record_uid
https://keepersecurity.com/vault/share#asdfsdjkkadsfdasfasdf

Python SDK

コマンド : 近日公開

One Time Share Listコマンド

レコードまたはフォルダに対して作成されたワンタイム共有を一覧するために使います。レコード/フォルダUID、共有名、共有ID、作成日時、アクセス日時、失効日時、およびリンクの状態 (生成済み、アクセス済み、失効) を表示します。

DotNet CLI

コマンド: one-time-share

アクション:

実行するアクションを指定する必須の位置引数。コマンド直後の位置0に置く。受け付ける値は次のとおり。

• list – レコードのワンタイム共有URLの一覧を表示する。

フラグ:

• value pos. 1 : 必須。対象のレコードUIDまたはパス。コマンド直後の位置1に置く位置引数。

• --client : ワンタイム共有のアクション名 list。コマンド直後の位置0の必須の位置引数。

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

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

例:

My Vault> one-time-share list record_uid  --client "Example Share" 
  #  Record UID              Record Title    Share Name   Generated          Opened             Expires          
---  ----------------------  -------------   -----------  -----------------  -----------------  -----------------    
  1  record_uid              Example Record  Share_name   8/28/2025 5:58 PM  8/28/2025 5:58 PM  8/28/2025 6:00 PM

DotNet SDK

メソッド:

public static async Task<ExternalRecordShare[]> GetExernalRecordShares(
    this VaultOnline vault, 
    string recordUid
)

引数:

• vault : ボルトコンテキストで使用する。

Vault.GetExernalRecordShares(record.Uid)

• recordUid : ワンタイム共有の一覧を表示するレコードのUID。

Power Commander

コマンド: Get-KeeperOneTimeShare

別名: kotsg

フラグ:

• -Uid : レコードのUid

例:

PS > Get-KeeperOneTimeShare record_uid

RecordUid              RecordTitle   Owner Users Folders
---------              -----------   ----- ----- -------
record_uid             Example Record         1       1

Python CLI

コマンド: share-list

パラメータ:

• record : レコード/フォルダの <UID> またはパス

オプション:

• -v, --verbose : 共有IDが長い場合に省略されないよう全体を表示する。

• -a, --all : 失効済みを含むすべてのワンタイム共有を表示する

• -R, --recursive : サブフォルダを再帰的にたどる

• --format : 出力形式 - table、json、csv

例:

My Vault> share-list record_uid --all

Record UID               Share Link Name    Share Link ID                                       Generated            Opened    Expires              Status
----------------------   -----------------  --------------------------------------------        -------------------  --------  -------------------  --------
record_uid                                  Share_link_uid                                      2025-08-06 16:54:11            2025-08-06 17:24:11  Expired

Python SDK

コマンド : 近日公開

One Time Share Removeコマンド

レコードまたはフォルダのワンタイム共有リンクを削除するために使います。

DotNet CLI

コマンド: one-time-share

フラグ:

• --client : ワンタイム共有のアクション名 delete。コマンド直後の位置0の必須の位置引数。

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

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

• value pos. 0 : 実行するアクションを指定する必須の位置引数。コマンド直後の位置0に置く。受け付ける値は次のとおり。

  • delete – ワンタイム共有を削除する

• value pos. 1 : 必須。対象のレコードUIDまたはパス。コマンド直後の位置1に置く位置引数。

例:

My Vault> one-time-share delete record_uid  --client "Example Share"  

DotNet SDK

メソッド:

public static async Task DeleteExernalRecordShares(
    this VaultOnline vault, 
    string recordUid, 
    IEnumerable<string> clientId
)

引数:

• VaultOnline : ボルトコンテキストで使用する。

var shares = (await context.Vault.GetExernalRecordShares(record.Uid))
Vault.DeleteExernalRecordShares(record.Uid, 
    shares.Select(x => x.ClientId))

• ClientId : レコードの共有のクライアントID。

Power Commander

コマンド: Remove-KeeperOneTimeShare

別名: kotsr

フラグ:

• -Uid : レコードのUid

• -ShareName : 共有名の一覧

例:

PS > Remove-KeeperOneTimeShare -Uid record_uid  -ShareName "Example Share"                     

Python CLI

コマンド: share-remove

パラメータ: 必須

• record : レコードまたはフォルダのUIDまたはパス

• share : ワンタイム共有ID

例:

My Vault> share-remove record_uid shared_link_uid
One-time share "share_link_uid" is removed from record "record_uid"

Python SDK

コマンド : 近日公開