アプリ キー API

OLP CLI は、アプリケーション API キー 管理のために次の機能をサポートしています。

• API キーを一覧表示します
• API キー を作成します
• API キー を更新します
• API キー を削除します
• API キー を有効にします
• API キー を無効にします

アプリ key API リスト

アプリケーションの API キーを取得します。

olp app key api list <app HRN> [command options]

必須パラメータ :

• <app HRN> アプリケーションの HERE リソースネーム 。

オプションのパラメータ :

• --enabled <true|false> に設定する trueと、有効な API キーでフィルタリングされます。 指定されていない場合は、すべてのキーが返されます。
• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --json コマンドの結果を JSON 形式で表示します。
• --quiet 追加情報のないキーのリストを表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドは、アプリケーションの API キーを一覧表示します。

olp app key api list hrn:here:account::org:app/my-app-1234 --json

出力 :

{"keys": [{
    "apiKey": "hrn:here:account::org:apikey/my-api-key-1234",
    "identity": "hrn:here:account::org:app/my-app-1234",
    "name": "API key example",
    "apiKeyId": "my-api-key-1234",
    "createdTime": 1591012921491,
    "realm": "hrn:here:account::org:realm/org",
    "enabled": true,
    "expiresAt": -1
}]}

アプリキー API 作成

アプリケーションの API キー を作成します。

olp app key api create <app HRN> <key name> [command options]

必須パラメータ :

• <app HRN> アプリケーションの HERE リソースネーム 。
• <key name> アプリケーション API キー の名前。

オプションのパラメータ :

• --expires-at <yyyy-MM-ddTHH:mm:ss> キーの有効期限。 タイムスタンプは、 yyyy-mm-ddThh:mm:ss という形式の ISO-8601 に一致する必要 がありますが、必須の形式は yyyy だけです。 指定しない場合、キーの有効期限は切れません。
• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --json コマンドの結果を JSON 形式で表示します。
• --quiet 空の出力を追加情報なしで表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドを実行すると、アプリケーション API キー が作成されます。

olp app key api create hrn:here:account::org:app/my-app-1234 api-key-name

出力 :

API key hrn:here:account::org:apikey/my-apikey-1234 has been created

アプリキーの API アップデート

アプリケーションの API キー を更新します。

olp app key api update <app HRN> <API key HRN> [command options]

必須パラメータ :

• <app HRN> アプリケーションの HERE リソースネーム 。
• <API key HRN> アプリケーション API キー の HERE リソースネーム 。
• 次のいずれかのパラメータを指定します。
  • --name <key name> アプリケーション API キー の名前。
  • --expires-at <yyyy-MM-ddTHH:mm:ss> キーの有効期限。 タイムスタンプは、 yyyy-mm-ddThh:mm:ss という形式の ISO-8601 に一致する必要 がありますが、必須の形式は yyyy だけです。 none が指定されている場合、キーの有効期限は切れません。

オプションのパラメータ :

• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --json コマンドの結果を JSON 形式で表示します。
• --quiet 空の出力を追加情報なしで表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドを使用すると、アプリケーション API キー の名前が更新されます。

olp app key api update hrn:here:account::org:app/my-app-1234 hrn:here:account::org:apikey/my-apikey-1234 --name api-key-name

出力 :

API key hrn:here:account::org:apikey/my-apikey-1234 has been updated

アプリキー API 削除

アプリケーションの API キー を削除します。

olp app key api delete <app HRN> <API key HRN> [command options]

必須パラメータ :

• <app HRN> アプリケーションの HERE リソースネーム 。
• <API key HRN> アプリケーション API キー の HERE リソースネーム 。

オプションのパラメータ :

• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --quiet 空の出力を追加情報なしで表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドを実行すると、アプリケーション API キー が削除されます。

olp app key api delete hrn:here:account::org:app/my-app-1234 hrn:here:account::org:apikey/my-apikey-1234

出力 :

API key hrn:here:account::org:apikey/my-apikey-1234 has been deleted

アプリキー API 有効

アプリケーションの API キー をイネーブルにします。

olp app key api enable <app HRN> <API key HRN> [command options]

必須パラメータ :

• <app HRN> アプリケーションの HERE リソースネーム 。
• <API key HRN> アプリケーション API キー の HERE リソースネーム 。

オプションのパラメータ :

• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --quiet 空の出力を追加情報なしで表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドを使用すると、アプリケーション API キー が有効になります。

olp app key api enable hrn:here:account::org:app/my-app-1234 hrn:here:account::org:apikey/my-apikey-1234

出力 :

API key hrn:here:account::org:apikey/my-apikey-1234 has been enabled

アプリキーの API が無効になりました

アプリケーションの API キー を無効にします。

olp app key api disable <app HRN> <API key HRN> [command options]

必須パラメータ :

• <app HRN> アプリケーションの HERE リソースネーム 。
• <API key HRN> アプリケーション API キー の HERE リソースネーム 。

オプションのパラメータ :

• --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。
• --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
• --quiet 空の出力を追加情報なしで表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンドを実行すると、アプリケーションの API キー が無効になります。

olp app key api disable hrn:here:account::org:app/my-app-1234 hrn:here:account::org:apikey/my-apikey-1234

出力 :

API key hrn:here:account::org:apikey/my-apikey-1234 has been disabled