シークレットマネージャーアプリケーションコマンド

アプリ利用に焦点を当てたKeeperシークレットマネージャーコマンドの使い方

Secrets Manager Appコマンド

このサブセットのシークレットマネージャーコマンドは、ボルト内の [シークレットマネージャー] > [アプリケーション] にあるKeeperシークレットマネージャーアプリケーションを扱います。アプリケーションのCRUDおよび共有/共有解除を行えるため、シークレットやフォルダなどのボルトデータにアプリ経由でアクセスできます。

コマンド:

Secrets Manager App List

この操作は、Keeperボルトで利用できるKeeperシークレットマネージャーアプリケーションをすべて表形式で取得して表示します。各行にはアプリケーション固有のUIDとタイトルが含まれます。アクセスやクライアントを管理する前に登録済みアプリをすばやく確認するのに便利です。

chevron-rightDotNet CLIhashtag

コマンド: ksm list

フラグ:

  • --folder : 共有フォルダのUIDまたは名前。「share」「unshare」のみ

  • -e, --can-edit : シークレットを編集できるか。「share」「unshare」のみ

  • --client-name : クライアント名。「add-client」「remove-client」のみ

  • --unlock-ip : IPアドレスのロックを解除するか。「add-client」のみ

  • --create-expire : デバイス作成の有効期限(分)。「add-client」のみ

  • --access-expire : デバイスアクセスの有効期限(分)。「add-client」のみ

  • --b64 : ワンタイムトークンの代わりにKSM構成を返す。「add-client」のみ

  • --email : ユーザーのUIDまたはメールアドレス。「app-share」「app-unshare」のみ

  • --is-admin : 管理者ユーザーとして共有する。「app-share」「app-unshare」のみ

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

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

  • value pos. 0 : KSMコマンドの候補: "view", "create", "delete", "share", "unshare", "add-client", "delete-client", "list", "app-share", "app-unshare"

  • value pos. 1 : シークレットマネージャーアプリケーションのUIDまたはタイトル

例:

My Vault> ksm list

  #  Application UID         Title          
---  ----------------------  ---------------
  1  ksm_app_uid             DemoApplication
chevron-rightDotNet SDKhashtag

ボルトが事前に認証済みであれば、次のコードでSDKからアプリケーション一覧を取得できます。

foreach (var app in context.Vault.KeeperRecords.OfType<ApplicationRecord>())
{
    Console.WriteLine(app.Uid, app.Title);
}
chevron-rightPowerCommanderhashtag

コマンド: Get-KeeperSecretManagerApp

エイリアス: ksm

フラグ:

  • -Uid

  • -Filter

  • -Detail

例:

chevron-rightPython CLIhashtag

コマンド: secrets-manager-app --command='list'

パラメーター:

  • --command : list

例:

chevron-rightPython SDKhashtag

関数: list_secrets_manager_apps

Secrets Manager App Create

create アクションは、Keeperボルトに新しいKeeperシークレットマネージャーアプリケーションレコードを作成します。このアプリケーションには、後からクライアントデバイスや共有フォルダを設定し、シークレット管理や自動化の用途に使えます。作成時にアプリケーション名(KsmId)を指定することもできます。

作成後、出力にアプリケーションのUIDとタイトルが表示されます。

chevron-rightDotNet CLIhashtag

コマンド: ksm create <APP_NAME>

フラグ:

  • --folder : 共有フォルダのUIDまたは名前。「share」「unshare」のみ

  • -e, --can-edit : シークレットを編集できるか。「share」「unshare」のみ

  • --client-name : クライアント名。「add-client」「remove-client」のみ

  • --unlock-ip : IPアドレスのロックを解除するか。「add-client」のみ

  • --create-expire : デバイス作成の有効期限(分)。「add-client」のみ

  • --access-expire : デバイスアクセスの有効期限(分)。「add-client」のみ

  • --b64 : ワンタイムトークンの代わりにKSM構成を返す。「add-client」のみ

  • --email : ユーザーのUIDまたはメールアドレス。「app-share」「app-unshare」のみ

  • --is-admin : 管理者ユーザーとして共有する。「app-share」「app-unshare」のみ

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

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

  • value pos. 0 : KSMコマンド: "view", "create", "delete", "share", "unshare", "add-client", "delete-client", "list", "app-share", "app-unshare"

  • value pos. 1 : シークレットマネージャーアプリケーションのUIDまたはタイトル

例:

chevron-rightDotNet SDKhashtag

メソッド: CreateSecretManagerApplication

例:

chevron-rightPowerCommanderhashtag

コマンド: Add-KeeperSecretManagerApp <appName>

フラグ:

  • -AppName

例:

chevron-rightPython CLIhashtag

コマンド: secrets-manager-app --command='create' or 'add'

パラメーター:

  • --command {list,get,add,create,remove,share,unshare} 次のいずれか: list, get, add, create, remove, share, unshare

  • --app, -a : 作成するシークレットマネージャーアプリの名前を指定します

オプション:

  • --force, -f : 同名のシークレットマネージャーアプリを強制的に追加します

例:

chevron-rightPython SDKhashtag

関数: create_secrets_manager_app

Secrets Manager App View

UIDまたは名前を指定して、特定のKeeperシークレットマネージャーアプリケーションの詳細を表示します。

このコマンドはボルトからアプリケーションレコードを取得し、UID、タイトル、共有状態、リンクされた共有フォルダ、関連レコードなどのメタデータを出力します。

動作:

  • 指定した名前を使ってボルトからKeeperシークレットマネージャーアプリケーションを取得します。

  • Keeperに保存されている内容に近い形で、アプリケーションの詳細の要約を出力します。

  • 監査や、構成およびアクセス関係の確認に便利です。

chevron-rightDotNet CLIhashtag

コマンド : ksm view <AppName>

フラグ :

  • --folder : 共有フォルダのUIDまたは名前。「share」「unshare」のみ

  • -e, --can-edit : シークレットを編集できるか。「share」「unshare」のみ

  • --client-name : クライアント名。「add-client」「remove-client」のみ

  • --unlock-ip : IPアドレスのロックを解除するか。「add-client」のみ

  • --create-expire : デバイス作成の有効期限(分)。「add-client」のみ

  • --access-expire : デバイスアクセスの有効期限(分)。「add-client」のみ

  • --b64 : ワンタイムトークンの代わりにKSM構成を返す。「add-client」のみ

  • --email : ユーザーのUIDまたはメールアドレス。「app-share」「app-unshare」のみ

  • --is-admin : 管理者ユーザーとして共有する。「app-share」「app-unshare」のみ

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

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

  • value pos. 0 : KSMコマンド: "view", "create", "delete", "share", "unshare", "add-client", "delete-client", "list", "app-share", "app-unshare"

  • value pos. 1 : シークレットマネージャーアプリケーションのUIDまたはタイトル

例:

chevron-rightDotNet SDKhashtag

メソッド: TryGetKeeperRecord

例:

chevron-rightPowerCommanderhashtag

コマンド: Get-KeeperSecretManagerApp

エイリアス : ksm <uid>

フラグ :

  • Uid

  • Filter

  • Detail

例:

chevron-rightPython CLIhashtag

コマンド: secrets-manager-app --command='get'

パラメーター:

  • --command = get

  • --app, -a : 取得する secrets-manager-app のUIDまたはタイトルです

例:

chevron-rightPython SDKhashtag

関数: get_secrets_manager_app

Secrets Manager App Delete

ユーザーが指定したUIDまたは名前のアプリケーションを削除します。

動作:

  • 指定された名前またはUIDに基づきシークレットマネージャーアプリケーションを取得します

  • (PowerShellでは) ユーザーに確認を求めます

  • 指定したUIDのアプリケーションを削除します

chevron-rightDotNet CLIhashtag

コマンド: ksm delete <APP_UID>

フラグ :

  • --folder : 共有フォルダのUIDまたは名前。「share」「unshare」のみ

  • -e, --can-edit : シークレットを編集できるか。「share」「unshare」のみ

  • --client-name : クライアント名。「add-client」「remove-client」のみ

  • --unlock-ip : IPアドレスのロックを解除するか。「add-client」のみ

  • --create-expire : デバイス作成の有効期限(分)。「add-client」のみ

  • --access-expire : デバイスアクセスの有効期限(分)。「add-client」のみ

  • --b64 : ワンタイムトークンの代わりにKSM構成を返す。「add-client」のみ

  • --email : ユーザーのUIDまたはメールアドレス。「app-share」「app-unshare」のみ

  • --is-admin : 管理者ユーザーとして共有する。「app-share」「app-unshare」のみ

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

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

  • value pos. 0 : KSMコマンド: "view", "create", "delete", "share", "unshare", "add-client", "delete-client", "list", "app-share", "app-unshare"

  • value pos. 1 : シークレットマネージャーアプリケーションのUIDまたはタイトル

例:

chevron-rightDotNet SDKhashtag

メソッド: DeleteSecretManagerApplication

例:

chevron-rightPowerCommanderhashtag

コマンド: Remove-KeeperSecretManagerApp <APP_UID>

エイリアス: ksm-delete

例:

chevron-rightPython CLIhashtag

コマンド: secrets-manager-app --command='remove' --app='<app_uid_or_name>'

パラメーター:

--command remove

オプション:

--force クライアントが紐付いているシークレットマネージャーアプリを強制削除します

例:

chevron-rightPython SDKhashtag

関数: remove_secrets_manager_app

Secrets Manager App Share

このコマンドは、指定したユーザーとアプリケーションを共有します。ユーザーが共有可能なプールに含まれていない場合 (既定ではチーム/エンタープライズ)、指定したメールアドレスに共有招待が送られます。

動作:

  • アプリの詳細と共有に関する情報を取得します

  • ユーザーがすでに共有可能なプールにおり、アプリへのアクセスがあるかを確認します

  • アプリを共有可能ならユーザーと共有し、そうでなければ招待付きのメールをユーザーに送ります

chevron-rightDotNet CLIhashtag

コマンド: ksm app-share APP_UID --email=USER_EMAIL --is-admin --can-edit --folder=<FOLDER_UID_FOR_SHARE_FOLDER>

フラグ

フラグ
使い方
説明

--can-edit

--can-edit

コマンドでこのフラグを指定すると、ユーザーの編集可否が true になり、共有されたアプリケーションをユーザーが編集できます。指定しない場合は読み取り専用です。

--folder

--folder=UID

指定する場合は --folder=FOLDER_UID の形式とします。アプリケーションがアクセスできるすべてではなく、サブフォルダだけをユーザーと共有します。

--is-admin

--is-admin

指定すると、ユーザーにアプリケーションおよび共有されているすべてへの管理者権限が付与されます。

--email

--email=id

必須です。--email=EMAIL_ID の形式で指定します。共有先ユーザーのメールアドレスです。

例:

chevron-rightDotNet SDKhashtag

メソッド: ShareRecordWithUser

フラグ:

関数パラメーター
使い方
説明

recordUid

<Record UID>

共有する必要があるアプリケーション/レコードのUIDです。

username

<Email>

アプリケーションを共有する相手ユーザーのメールまたはユーザーIDです。

options.CanEdit

boolean

アプリケーションのデータを編集できるかどうかです。

options.CanShare

boolean

アプリケーションを共有できるかどうかです。

userType

Enum

ユーザーの種類(エンタープライズユーザーまたは通常ユーザー)です。

例:

注意:

  • この方法でアプリケーションを共有するには手順に従う必要があります。

  • ユーザーとアプリケーションを共有するときは、まずこのアプリケーションがアクセスできるすべてのレコードを取得します。

  • すべてのレコードを取得したら、必要な権限で ShareRecordWithUser を用いて、該当ユーザーとレコードを1件ずつ共有します。

  • アプリケーションがアクセスできる共有フォルダをすべて取得したら、PutUserToSharedFolder を使って各共有フォルダにユーザーを追加します。

  • 上記がすべて完了したら、適切な権限で ShareRecordWithUser を用いて、ユーザーとアプリケーションレコード(アプリ本体)を共有します。

  • 以上でアプリケーションの共有は完了です。

chevron-rightPowerCommanderhashtag

コマンド: Grant-KeeperAppAccess -ApplicationId <APP_UID> -UserUid <USER_ID>

フラグ:

フラグ
使い方
説明

-IsAdmin

-IsAdmin

指定すると、ユーザーにアプリケーションおよび共有されているすべてへの管理者権限が付与されます。

-UserUid

-UserUid <id>

必須です。`-UserUid EMAIL_ID` の形式で指定します。共有先ユーザーのメールアドレスです。

例:

chevron-rightPython CLIhashtag

コマンド: secrets-manager-app --command='share'

フラグ:

  • --command = share

  • -a, --app : 共有するアプリの名前またはUIDです

  • -e, --email : アプリを共有/共有解除する相手ユーザーのメールアドレスです

  • --admin : アプリ内のレコードを共有・編集する管理者権限です

例:

chevron-rightPython SDKhashtag

関数:

Secrets Manager App UnShare

このコマンドは、指定したユーザーとのアプリケーション共有を解除します。ユーザーのアプリケーションへのアクセスに加え、アプリケーション配下のフォルダとレコードへのアクセスも取り消されます。

動作:

  • アプリの詳細と共有に関する情報を取得します

  • ユーザーがアプリへのアクセス権を持つかを確認します

  • ユーザーが見つからない場合は、その旨を示してコマンドを終了します

  • アプリがユーザーと共有されている場合は、アプリ内のレコードとフォルダへのアクセスを削除したうえで、アプリへのアクセスを取り消します

chevron-rightDotNet CLIhashtag

コマンド: ksm app-unshare APP_UID --email=USER_EMAIL

フラグ

フラグ
使い方
説明

email

--email=id

必須です。--email=EMAIL_ID の形式で指定します。アプリケーションに関するアクセスを取り消すユーザーです。

例:

chevron-rightDotNet SDKhashtag

メソッド: RevokeShareFromUser / RemoveUserFromSharedFolder

フラグ:

関数パラメーター
使い方
説明

recordUid

<Record UID>

取り消す必要があるアプリケーション/レコードのUIDです。

username

<Email>

アプリケーションの共有を取り消す相手ユーザーのメールまたはユーザーIDです。

userType

Enum

ユーザーの種類(エンタープライズユーザーまたは通常ユーザー)です。

例:

注意:

  • アプリケーションへのアクセスを取り消すにはこの手順に従う必要があります

  • ユーザーからアプリケーションの共有を取り消すときは、まずこのアプリケーションがアクセスできるすべてのレコードを取得します

  • すべてのレコードを取得したら、必要な権限で RevokeShareFromUser を用いて該当ユーザーからすべて取り消します

  • アプリケーションがアクセスできる共有フォルダをすべて取得したら、RemoveUserFromSharedFolder を使って各共有フォルダからユーザーを削除します

  • 上記がすべて完了したら、RevokeShareFromUser を用いてユーザーからアプリケーションを取り消します

  • 以上でアプリケーションの共有取り消しは完了です

chevron-rightPowerCommanderhashtag

コマンド: Revoke-KeeperAppAccess -ApplicationId <APP_UID> -UserUid <USER_ID>

フラグ:

フラグ
使い方
説明

UserUid

-UserUid <id>

必須です。`-UserUid EMAIL_ID` の形式で指定します。アクセスを取り消す対象ユーザーのメールアドレスです。

例:

chevron-rightPython CLIhashtag

コマンド: secrets-manager-app --command='unshare'

パラメーター:

--command = unshare

-a --app 共有解除するアプリの名前またはUIDです

-e --email アプリを共有/共有解除する相手ユーザーのメールアドレスです

例:

chevron-rightPython SDKhashtag

関数:

最終更新

役に立ちましたか?