CLI を使い始める

​
service-accounts

@orchestor-inc/cli のコマンドリファレンスです。

CLI ではワークスペースに紐づくサービスアカウントだけを管理できます。作成と更新、キー発行には project:update 権限が必要です。

​
コマンド一覧

  • orc service-accounts list — 現在のワークスペースのサービスアカウントを一覧する
  • orc service-accounts create — ワークスペースにサービスアカウントを作成する
  • orc service-accounts get — サービスアカウントを取得する
  • orc service-accounts update — 名前または状態を更新する
  • orc service-accounts keys create — サービスアカウントへキーを発行する

​
orc service-accounts list

orc service-accounts list --workspace WORKSPACE_ID --json

ページングには --limit と --cursor を使います。返却値には ID、ロール、状態、ワークスペース ID が含まれます。

​
orc service-accounts create

orc service-accounts create \
  --workspace WORKSPACE_ID \
  --name "CI bot" \
  --scope workspace \
  --json

CLI では --scope workspace だけを使用できます。--scope organization は、組織スコープの一覧と失効が提供されるまで拒否されます。

​
orc service-accounts get

orc service-accounts get SERVICE_ACCOUNT_ID --workspace WORKSPACE_ID --json

​
orc service-accounts update

orc service-accounts update SERVICE_ACCOUNT_ID \
  --workspace WORKSPACE_ID \
  --status suspended \
  --json

status は active、suspended、deleted のいずれかです。suspended は既存キーを無効にし、active に戻すと再び利用できます。deleted は恒久的な削除です。

​
orc service-accounts keys create

キーは一度だけ返されます。発行前に、ソース管理外の新しいファイルを出力先として指定してください。CLI は所有者だけが読める権限でファイルを作成し、既存ファイルを上書きしません。

orc service-accounts keys create SERVICE_ACCOUNT_ID \
  --workspace WORKSPACE_ID \
  --name "CI read key" \
  --permissions '{"answers":"read"}' \
  --output /secure/path/service-account-key \
  --json

標準出力と標準エラーにはキーを出しません。キー値をログ、チャット、Issue、ソースコードへ貼り付けないでください。通常出力のキー ID は orc api-keys list の service_account_id で識別でき、不要になったキーは次のコマンドで失効できます。

orc api-keys delete API_KEY_ID --workspace WORKSPACE_ID --yes --json

各コマンドの完全な引数とフラグは --help で確認できます。共通オプションはグローバルオプションを参照してください。