Skip to main content

APIキー作成手順

  1. ダッシュボードから「APIキー」を選択
  2. 「新規作成」をクリック
  3. キー情報を入力
  4. 必要なスコープを1つ以上選択
    • チェックしたスコープだけが付与されます
    • スコープは作成時のみ付与でき、後から変更できません
    • 各機能に必要なスコープはSDKs / API Referenceをご参照ください
  5. 「保存する」をクリック
APIキーの権限はスコープだけで決まります。一覧に表示される「旧role(監査)」は 既存キーの記録用であり、アクセス可否の判定には使われません。

APIキーからAPIキーを発行する

CI などの自動化から発行したい場合は、apikeys:issue スコープを付けたキーを ダッシュボードで作成し、POST /api-keys(SDK: client.api_keys.create、 CLI: qaip api api-keys.create)を呼び出します。 発行されるキーは必ず呼び出し元より弱くなります。
  • 付与できるのは、呼び出し元のキーが持つスコープの部分集合だけです
  • apikeys:issue 自体は付与できません(発行したキーはさらに発行できません)
  • external_data:* は付与できません(ダッシュボードからの発行が必要です)
生成されたAPIキーは一度しか表示されません。必ず安全な場所に保存してください。