プロジェクト
OLP CLI は、プロジェクトで次の機能をサポートしています。
プロジェクトリスト
アクセスできるプロジェクトが一覧表示されます。
olp project list [command options]
オプションのパラメータ :
-
[filter]
プロジェクトリストをフィルタリングする freeform テキスト。 フィルターは、プロジェクトの HERE リソースネーム 、名前、または説明にfilter
文字列が含まれているかどうかを確認します。 --limit <max number of projects>
結果に返されたプロジェクトの最大数 ( 既定では 100) 。-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 --json
コマンドの結果を JSON 形式で表示します。-
--quiet
プロジェクトの HRNS を新しい行に表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンド myproject
は、 HERE リソースネーム 、名前、または説明が一致するプロジェクトを一覧表示します。
olp project list myproject --json
出力 :
{"projects": [
{
"hrn": "hrn:here:authorization::org:project/myproject",
"name": "my-project-name",
"description": "my project description",
"id": "myproject"
}
]
}
プロジェクトを作成します
プロジェクトを作成します。
olp project create <project-id> <project name> [command options]
必須パラメータ :
-
<project-id>
プロジェクトの HERE リソースネーム の最後の部分として使用される一意のプロジェクト ID 。<project-id>
4 ~ 16 文字の英数字であることが必要です。小文字、数字、ハイフンを使用できます。 ハイフンは文字列の先頭または末尾では使用できません。 -
<project name>
プロジェクトの人間が読める名前。 プロジェクト名は、小文字または大文字、数字、ハイフンのセットから 200 文字までの英数字である必要があります。
注
プロジェクトのアクセス権
既定 では、プロジェクトを作成するアプリには、そのプロジェクトに対する ProjectAdmin 権限が付与されます。 このアプリを使用して、 CLI を介してプロジェクトアクセスとプロジェクトリソースの両方を管理します。
関連付けられているユーザーアカウントには 、プロジェクトのユーザー権限のみが付与され、 HERE platform ポータルを介してプロジェクトリソースを管理できます。 この--skip-sharing-with-user
フラグを使用 して、プロジェクト作成時にユーザーアカウントからユーザー権限を削除します。
オプションのパラメータ :
-
--description <project description>
プロジェクトおよびその内容の詳細な説明。 デフォルト値は空です。 文字列は 500 文字を超えることはできません。 説明は引用符で囲んでください。 -
--skip-sharing-with-user
関連付けられているユーザーアカウントでプロジェクトにアクセスする権限を共有しないでください。 CLI がユーザーアカウントと権限を共有するため、デフォルト値は false です。 このオプションを使用すると、関連付けられているユーザーアカウントが、作成できるプロジェクトリソースの上限に達しないようにできます。 -
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを使用すると、新しいプロジェクトが作成されます。
olp project create myproject my-project-name --description "my project description"
出力 :
Project hrn:here:authorization::org:project/myproject has been created
プロジェクトの更新
プロジェクトの名前または説明を更新します。
olp project update <project HRN> [command options]
必須パラメータ :
-
<project HRN>
プロジェクトの HERE リソースネーム 。
オプションのパラメータ :
-
--name <project name>
プロジェクトの新しい読み取り可能な名前。 何も指定しない場合、元の名前が保持されます。 -
--description <project description>
プロジェクトとその内容の新しい説明。 文字列は 500 文字を超えることはできません。 説明は引用符で囲んでください。 何も指定しない場合、元の説明が保持されます。 --scope-access <thisProjectOnly|thisProjectOrNoProject>
このプロジェクトの範囲内で操作する場合に許可されるアクセス範囲 ( プロジェクトスコープのトークン を使用 ) 。 使用可能--scope-access
な値 :thisProjectOnly
このプロジェクトにスコープ指定されたリクエストは、このプロジェクトのスコープ内で利用可能なリソースおよび API 呼び出しにのみアクセスできます。thisProjectOrNoProject
このプロジェクトにスコープ指定されたリクエストは、このプロジェクトのスコープ内で利用可能なリソースおよび API 呼び出しにアクセスできます。また、呼び出し元の ID がアクセス権を持つプロジェクトに関連付けられているリソースおよび API 呼び出しにもアクセスできます。
--default-new-member-policies <list of policies>
新しいプロジェクトメンバーの既定のポリシーを含むコンマ区切りのリスト。 デフォルト値all-access-all-project-resources
およびresource-creation-access-all-project-resources
。 空のパラメータを指定して、デフォルトのポリシーを削除できます。-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、 HERE platform ポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを使用すると、プロジェクトの名前が更新されます。
olp project update hrn:here:authorization::org:project/myproject --name "my updated name"
出力 :
Project hrn:here:authorization::org:project/myproject has been updated
例 :
次のコマンドを使用すると、新しいプロジェクトメンバーの既定のポリシーが更新されます。
olp project update hrn:here:authorization::myrealm:project/myproject --default-new-member-policies hrn:here:authorization::HERE:platform:policy/some-policy-id,hrn:here:authorization::HERE:platform:policy/another-policy-id
出力 :
Project hrn:here:authorization::myrealm:project/myproject has been updated
プロジェクトショー
プロジェクトの詳細を表示します。
olp project show <project HRN>
必須パラメータ :
-
<project HRN>
プロジェクトの HERE リソースネーム 。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 --quiet
プロジェクト名を表示します。--json
コマンドの結果を JSON 形式で表示します。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
以下のコマンドは、プロジェクトの詳細を表示します。
olp project show hrn:here:authorization::org:project/myproject --json
出力 :
{
"hrn": "hrn:here:authorization::org:project/myproject",
"name": "my-project-name",
"description": "my project description",
"id": "myproject",
"scopeAccess": "thisProjectOnly",
"defaultNewMemberProjectPolicies": [
"hrn:here:authorization::HERE:platform:policy/all-access-all-project-resources",
"hrn:here:authorization::HERE:platform:policy/resource-creation-access-all-project-resources"
]
}
プロジェクトを削除します
プロジェクトを削除します。
olp project delete <project HRN>
必須パラメータ :
-
<project HRN>
削除するプロジェクトの HERE リソースネーム 。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。
警告
プロジェクトの削除
プロジェクトを削除すると、プロジェクトアクセス権を持つすべてのユーザー、アプリ、およびグループに影響が出る可能性があります。 プロジェクト内から作成されたリソースがある場合は、まずこれらのリソースを削除してから、プロジェクト自体を削除する必要があります。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを実行すると、プロジェクトが削除 myproject
されます。
olp project delete hrn:here:authorization::org:project/myproject
出力 :
Project hrn:here:authorization::org:project/myproject has been deleted