API キー

APIキーの管理は、組織レベルでロールベースのアクセス制御(RBAC)で管理されます。各キーは組織全体に役割を割り当てることができ、任意のアプリに役割を割り当てることも可能で、各キーがどれだけのアクセス権を持つかを細かく制御できます。

APIキーのどこで管理されるのですか?

ナビゲート 設定 > 組織 > API キー at console.capgo.app/settings/organization/api-keys.

このページには2つのセクションが表示されます:

• RBAC キー 役割が割り当てられたキー (推奨)。これらのキーは、新しいロールベースの許可システムを使用します。
• レガシーキー —古いキーがロール割り当てなしでシンプルモードベースのシステム (read, upload, write, all) を使用します。

API キーを作成する方法

1. RBAC キー テーブル上部の「」ボタンをクリックします。 ”+” RBAC キー テーブル上部の「」ボタンをクリックします。

2. RBAC キー テーブル上部の「」ボタンをクリックします。 キー情報:

   • キー名 (必要) — このキーに付ける説明ラベルを入力してください (例: "CI/CD Deploy", "Monitoring Read-Only")。
   • セキュアなキーを作成 (任意) — このチェックボックスをオンにすると、キーはサーバー側でハッシュ化されます。 キーは、作成後一度だけ表示されます。後で取得することはできません。 有効期限を設定
   • (任意) — 有効期限を設定すると、キーはその日以降使用できなくなります。組織のポリシーにより、強制的な有効期限が設定される場合があります。 __CAPGO_KEEP_0__ — 組織名、セキュアキー設定、有効期限の設定

3. 組織ロール — 組織全体でキーが持つ基本的な権限を定義します。利用可能なロールは、自分のロールのレベルによって異なります: なし

   • organizationRoleOptions — 組織全体へのアクセス権がない;キーは個別に割り当てられたアプリにのみアクセスできる。
   • メンバー — 組織全体への基本的な読み取りアクセス権。
   • 管理者 — 組織全体への完全な管理権限 (すべてのアプリへのアクセス権を継承)。

4. 選択した組織ロールが Admin ではない場合、 アプリごとのアクセス権を追加できます。:

   • 「 アプリを追加」 」をクリックしてアプリ選択画面を開きます。
   • 1 つまたは複数のアプリを選択し、それぞれにロールを割り当てます。
     • アプリ閲覧者 — アプリに読み取り専用のアクセス権限があります。
     • アプリアップローダー — 新しいバンドルをアップロードできます。
     • アプリ開発者 — アプリの構成とデプロイを管理できます。
     • アプリ管理者 — アプリにフルアクセス権限があります。

5. クリック “Create”.

6. If you checked “Create secure key”, a modal will display the plain-text key. Copy it immediately — 閉じたモーダルから復元することはできません。

API キーの管理（編集）方法

リスト内のRBACキーに表示されている 工具アイコン （管理）をクリックすると、キー詳細ページが開きます。ここでは、以下の操作が可能です。

• キー名の変更 組織ロールの更新.
• 追加、削除、または変更 Click the wrench icon (Manage) on any RBAC key in the list. This opens the key detail page where you can: Change the key name, Update the organization role, Add, remove, or change.
• This opens the key detail page where you can: Change the key name, Update the organization role, Add, remove, or change アプリごとのロール.

クリック 保存する 終わったら。

APIキーを再生成する方法

API キーのシークレット値を再生成するには、ボタンをクリックしてください。 リフレッシュアイコン リスト内の任意のキーを押すと再生成されます。

確認ダイアログが表示されます。確認後は、

• For 安全 (ハッシュ) キー: 新しいプレーン テキスト キーがモーダル内で一度表示され、コピーするように促される。
• For プレーン キー: キー値はサーバー側で再生成される。

旧キーの値を使用する任意の統合は即座に機能を停止する。

キー API を削除する方法

リスト内の任意のキーに表示される「ごみ箱アイコン」(削除)をクリックします。 確認ダイアログで削除を確認します。 trash icon

キーは即時で削除されます — これを使用するリクエストはすべて失敗します。

古いキー

古いキー (役割割り当てなしのキー) を見つけた場合、これらはモードベースのパーミッションシステム ( ) を使用しています。まだ機能しますが、RBAC の細かいパーミッションの利点を受けられません。 古いキーはリストから再生成および削除できますが、RBAC のロールを追加するために編集することはできません。新しい RBAC キーを作成し、古いキーを削除することを推奨します。read, upload, write, all古いキーを直接管理する必要がある場合は、まだアクセスできます。

console.__CAPGO_KEEP_0__.app/dashboard/apikeys

このページは廃止予定であり、将来のアップデートで削除されます。 console.capgo.app/dashboard/apikeys古いキー