秘密
OLP CLI は、サードパーティのシークレット管理で次の機能をサポートしています。
- シークレットを作成します
- シークレットを削除します
- シークレットを無効にします
- シークレットを有効にします
- 発信者がアクセスできるシークレットを一覧表示します
- シークレットを更新します
シークレットを作成します
シークレットを作成します。
olp secret create [command options]
必須パラメータ :
<secret name>
サードパーティのシークレットの名前。 <secret content>
サードパーティのシークレットコンテンツへのファイルパス(プレーンテキスト)。 <type>
サードパーティのシークレットのタイプ。 「カスタム」または「 AWS 」のいずれかにする必要があります。
オプションのパラメータ :
-
--expires <yyyy-MM-ddTHH:mm:ss>
シークレットの有効期限。 タイムスタンプは ISO-8601 形式に一致 yyyy-MM-ddTHH:mm:ss
する必要があります。 たとえば、「 2020-12-23T02:24:00.000Z 」のように入力します。 指定しない場合、シークレットの有効期限は切れません。 --grant-read-to <hrn>
指定したアプリ またはユーザー HERE リソースネーム にシークレットへの読み取りアクセス権を付与します。 アプリの HERE リソースネーム を取得するには olp app list
、コマンドを使用します。 --filename <file name>
ファイルシステムにプレーンテキストでシークレットを書き込むために使用するプラットフォーム の相対ファイル名。 ファイルは type
、プロパティで指定されたディレクトリに配置されます。 デフォルトはです credentials
。 -
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini ファイルから使用する資格情報プロファイルの名前。 --json
コマンドの結果を JSON 形式で表示します。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを実行すると、サードパーティのシークレットが作成されます。
olp secret create my-key-1234 ~/.aws/my-aws-secrets.txt aws
olp secret create my-key-1234 C:\Users\username\.aws\my-aws-secrets.txt aws
出力 :
Secret hrn:here:here:account::org:secret/my-key-1234 has been created
シークレットの削除
シークレットを削除します。
olp secret delete [command options]
必須パラメータ :
-
<secret HRN>
サードパーティのシークレットの HERE リソースネーム 。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを実行すると、サードパーティのシークレットが削除されます。
olp secret delete hrn:here:here:account::org:secret/my-key-1234
出力 :
Secret hrn:here:here:account::org:secret/my-key-1234 has been deleted
シークレット無効化
シークレットを無効にします。
olp secret disable [command options]
必須パラメータ :
-
<secret HRN>
サードパーティのシークレットの HERE リソースネーム 。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを実行すると、サードパーティのシークレットが無効になります。
olp secret disable hrn:here:here:account::org:secret/my-key-1234
出力 :
Secret hrn:here:here:account::org:secret/my-key-1234 has been disabled
シークレットの有効化
シークレットを有効にします。
olp secret enable [command options]
必須パラメータ :
-
<secret HRN>
サードパーティのシークレットの HERE リソースネーム 。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを使用すると、サードパーティのシークレットを有効にできます。
olp secret enable hrn:here:here:account::org:secret/my-key-1234
出力 :
Secret hrn:here:here:account::org:secret/my-key-1234 has been enabled
シークレットリスト
発信者がアクセスできるシークレットを一覧表示します。
olp secret list [command options]
オプションのパラメータ :
-
--enabled <true|false>
true に設定すると、有効なシークレットのみが返されます。 指定しない場合は、すべてのシークレットが返されます。 -
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 --json
コマンドの結果を JSON 形式で表示します。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを実行すると、すべてのサードパーティのシークレットが一覧表示されます
olp secret list --json
出力 :
{"secrets": [{
"id": "my-key-1234",
"type": "aws",
"filename": "credentials",
"name": "external key example",
"hrn": "hrn:here:here:account::org:secret/my-key-1234",
"sha256": "C01DCECC41CA1E27BB0D41B089528D6D15443AF24E710A005BB2372CD107474E",
"enabled": true,
"created": "2020-10-09T07:32:00.000Z",
"modified": "2020-10-09T07:32:00.000Z",
"expires": "2020-12-28T02:24:00.000Z"
}]}
シークレットの更新
シークレットを更新します。
olp secret update [command options]
必須パラメータ :
-
<secret HRN>
サードパーティのシークレットの HERE リソースネーム 。
オプションのパラメータ :
--name <secret name>
サードパーティのシークレットの名前。 --type <custom|aws>
サードパーティのシークレットのタイプ。 「カスタム」または「 AWS 」のいずれかにする必要があります。 --secret-content <path to secret content>
サードパーティのシークレットコンテンツへのファイルパス(プレーンテキスト)。 --filename <file name>
ファイルシステム上でシークレットをプレーンテキストで書き込むために使用するプラットフォーム の相対ファイル名。 ファイルは type
、プロパティで指定されたディレクトリに配置されます。 デフォルトはです credentials
。 -
--expires <yyyy-MM-ddTHH:mm:ss>
シークレットの有効期限。 タイムスタンプは ISO-8601 形式に一致 yyyy-MM-ddTHH:mm:ss
する必要があります。 たとえば、「 2020-12-23T02:24:00.000Z 」のように入力します。 -
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 --json
コマンドの結果を JSON 形式で表示します。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを使用すると、サードパーティのシークレットの名前が更新されます。
olp secret update hrn:here:here:account::org:secret/my-key-1234 --name new-name
出力 :
Secret hrn:here:here:account::org:secret/my-key-1234 has been updated