はじめに

​
API キーで最初のリクエストを送る

CLI 認証でワークスペース用の API キーを作成し、一度だけ返るシークレットを安全なファイルへ保存します。API キー自身ではキーを管理できません。

​
手順

orc auth login
orc api-keys create \
  --workspace WORKSPACE_ID \
  --name "Read automation" \
  --type read_only \
  --scope workspace \
  --output /secure/path/api-key \
  --json

--output には存在しないファイルを指定します。CLI はシークレットを owner-only (0600) のファイルへ原子的に保存し、既存ファイルを上書きしません。標準出力の JSON はシークレットを含まないメタデータだけです。CLI から作成できるのは workspace スコープだけです。

​
キーを使う

安全なファイルからプロセス環境へキーを注入し、必要な取得を確認します。値を端末へ表示しません。

export ORCHESTOR_API_KEY="$(< /secure/path/api-key)"
orc brands list --workspace WORKSPACE_ID --json

​
一覧、更新、交換

orc api-keys list --workspace WORKSPACE_ID --json
orc api-keys update KEY_ID --workspace WORKSPACE_ID --name "Read automation v2" --json

キーを交換するときは、別の新規パスへ新しいキーを作成し、そのキーで必要な取得が成功してから古いキーを失効させます。

orc api-keys create \
  --workspace WORKSPACE_ID \
  --name "Read automation replacement" \
  --type read_only \
  --output /secure/path/api-key-next \
  --json
orc api-keys delete OLD_KEY_ID --workspace WORKSPACE_ID --yes --json

api-keys リファレンス · ワークフロー一覧

失敗が残る場合は、失敗を報告して再検証するで、このワークフローと失敗した手順を報告へ添えます。