資格情報 を設定します
このセクションでは、次のことを行います。
資格情報を入手してください
OLP CLI が HERE platform に接続できるように、資格情報を取得して適切に設定する必要があります。
資格情報 が認証に使用されます。 HERE platform では、アプリとアクセスキーの概念を使用してリソースへのアクセスを制御します。 詳細について は、『 Identity & Access Management Guide 』を参照してください。
資格情報 は 、here.access.key.id
およびhere.access.key.secret
で構成 され、credentials.properties
ファイルに含まれています。 このファイルは、アプリ のアクセスキーを作成するときに プラットフォーム ポータル からダウンロードでき ます(資格情報 の設定で以下の手順を参照してください)。 次のスニペット は credentials.properties
、ファイルの例を示しています。
here.user.id = HERE-01966c94-aaf1-4ae2-a1y6-6516b3f9b6c1
here.client.id = mzLcb1rL8nskvDQpCAAO
here.access.key.id = BELUTk45QdaYGgZ9A_IMTA
here.access.key.secret = 108lI7w9m8G_6sIw9kng-PXGoeHQQ-cv6xByNOuMcRYixZZp...
here.token.endpoint.url = https://account.api.here.com/oauth2/token
資格情報 の設定
資格情報を設定するには、次の手順を実行します。
- プラットフォームポータルの右上隅 にあるアカウントアイコンをクリックし、 [ アプリとキー ] を選択します。
- [ 新しいアプリを登録 ] ボタンをクリックし、要求された情報を指定します。
- 資格情報 タブで 、 OAuth 2.0 タブに移動し 、 Create 資格情報をクリックします。
-
表示されたダイアログボックスで 、 [ ダウンロードcredentials.properties
] をクリックしてファイルをダウンロードします。
[ 閉じる] をクリックすると、アクセスキー ID にアクセスできなくなり、キーシークレットにアクセスできなくなります。
-
デフォルトのプロファイルを作成し、資格情報をそのプロファイルに関連付けるには、次のコマンドを実行します。
olp credentials import default credentials.properties
-
資格情報が正しく設定されていることを確認するには、 OLP CLI JAR ファイル が含まれているディレクトリで次のコマンドを実行します。
olp api token get
資格情報が正しく設定されている場合、次のような出力が生成されます。
Token: eyJhbGciOiJSUzUxMiIsImN0eSI6IkpXVCIsImlzcyI6IkhFUkUiLCJhaWQiOiJtekxjYjFyTDhuc2t2RFFwQ0ZFRiIs
ImlhdCI6MTUyMTgwNjYyOCwiZXhwIjoxNTIxODkzMDI4LCJraWQiOiJqMSJ9.ZXlKaGJHY2lPaUprYVhJaUxDSmxibU1pT2lKQk
1qVTJRMEpETFVoVE5URXlJbjAuLmtGc0JMODJibEUxTHhCS1M3MEctcFEuZHhsb2psaklEQmdNVEdoMEFKMHAzUU9yeE9INXdhd
1hkWjVSLS1Kdkc3VFBoUkRWY3owcUFYZ0V2Y3kwOGpMdzBCR09sNjJfZ2pxeUNuLXhET3JtZV8xNUlkV0tJN2VxTUpZNTNJelRx
ZjhUSzdVVHlEUlJFVnBLRW5BN2FvR2MubFViMTNGYWdKMlVGZXVQZnZsVG44Y2JqTzdtbF9ncGpLamFUN0xmZFF0UQ.EPYB9Rdy
jCHFxrqpaEBWkPzhPmFrAPBKlkt8SQpcI0k71mH_vC6txh6Uv1NVQC4xYyWG7ueq5mb4mcQh1sCorcv15GwIH1R0v0NR_CRPh-M
DNSFtg8HNnWyC1ePsfUGpSqjucQW8RMdbsU03wDO50Pr3ctQI4BZrxiU4HW6tdQq9_TinizujACzE-LMZ6FlFAb6pPB8TDsFlY3
9OmBFXEanaPvZwE01dKjE1K_A_G1_TiJzWo4vwuNeD54HfmOf6hN1IE8-CCSKRoIFoIBiVNqqzyCybyovRlSCWzSaTNz4v9BD7N
2lDgEuBlpn3q0qTFppZzjEvzv3RicGrCC_tmB
Token Expires at: 2018-03-24T14:03:48.100Z
資格情報を使用して、 OLP CLI 経由で HERE platform リソースに接続できるようになりました。
警告 :
資格情報を保存しています
資格情報を非公開にします。 ワークステーションまたはユーザー間で共有しないでください。 GitHub などのパブリックリポジトリにはコミットしないでください。
資格情報 設定オプションの詳細について は、「資格情報 を取得する」を参照してください。
範囲
HERE platform は 、 OAuth2 スコープを メカニズムとして使用して、特定のリソースへのアクセスを制御します。 スコープをサポートする各 OLP CLI コマンドは、要求で使用するスコープを次の優先順位で解決します。
-
--scope <project HRN>
: リクエストで使用するスコープを指定するオプションのパラメータ。
-
here.token.scope
: リクエストに使用される資格情報に含めるオプションの属性。
-
アプリケーションの既定の範囲 : リクエストを作成しているクライアントに既定のスコープが設定されていて、上記の 2 つのパラメータのいずれも存在しない場合、そのクライアントの既定のスコープがリクエストで使用されます。
-
上記の 3 つの場所のいずれにもスコープが見つからない場合、リクエストはスコープを使用しません。
プロファイル
資格情報プロファイル を使用すると、複数のプロファイルを定義して、プロジェクトごとに異なる資格情報を使用できます。 資格情報プロファイルを使用 credentials.properties
して、複数のファイルから複数のアプリ資格情報を管理および整理できます。
プロファイルと関連する資格情報 が .here/olpcli.ini
、ホームディレクトリのファイルに保存されます。 資格情報 コマンドを使用してプロファイルを管理できます。 .here/olpcli.ini
このファイルは olp credentials import
、以下の設定セクションで説明するように、コマンドを使用して最初のプロファイルを追加した後に作成されます
資格情報 を OLP CLI に渡します
OLP CLI では、 CLI コマンドのオプションのパラメータを使用するか、または環境変数を設定して、資格情報を渡すことができます。 OLP CLI は、次の順序で資格情報を解決します。
-
--credentials <path to credentials file>
: 該当する CLI コマンドの末尾に追加するオプションのパラメータ。 このパラメータ credentials.properties
は、コマンドで使用するファイルへのパスを指定します。
たとえば、次のコマンドを実行します。
olp catalog layer show hrn:here:data::org:test-catalog test-layer --credentials credentials.properties
test-layer
資格情報で hrn:here:data::org:test-catalog
カタログへのアクセスが許可されている場合、レイヤーのプロパティが表示されます。
-
OLP_CREDENTIALS
: credentials.properties
すべての CLI コマンドにデフォルトで使用されるファイルへのパスを定義する環境変数。
-
--profile <profile name>
: 該当する CLI コマンドの末尾に追加するオプションのパラメータ。 このパラメータは、コマンドで使用するプロファイルの名前を指定します。
たとえば、次のコマンドを実行する olp-user
と、すべてのパブリック HERE platform カタログを含む、プロファイルにアクセスできるカタログのリストが表示されます。
olp catalog list --profile olp-user
-
OLP_PROFILE
: すべての CLI コマンドにデフォルトで使用するプロファイルの名前を定義する環境変数。
-
default
プロファイル : 以下のコマンドを実行して作成したプロファイル。
olp credentials import default credentials.properties
-
credentials.properties
デフォルトの場所 : .here
資格情報ファイルがデフォルトで保存されているホームディレクトリ内のフォルダへのパス。
注
一部の OLP CLI コマンドでは、を指定する必要が group ID
あります。 管理者がアカウントに関連するグループ ID を設定し、そのグループにアプリケーションを割り当てる必要があります。 アプリがグループに割り当てられていない場合、コマンドによってエラーが発生します。 グループ ID の詳細について は、『 ID およびアクセス管理ガイド』を参照してください。