メインコンテンツにジャンプ
Capgo - Capacitorアプリ向けのライブアップデート Capgo

API キー

どこでAPIキーが管理されますか?

API

「API キーの管理はどこで行われますか？」というセクション

を 設定 > 組織 > API キー に console.capgo.app/settings/organization/api-keys.

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

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

APIを作成する方法は何ですか？

APIを作成する方法のセクション

  1. 上部のRBACキー表の ”+” ボタンをクリックしてください。

  2. キー情報を入力してください キー名:

    • (必須) — キー名（例：「CI/CD Deploy」、「Monitoring Read-Only」）を入力してください。 安全なキーを作成
    • (任意) — チェックすると、キーはサーバー側でハッシュ化されます。 キーは作成後 一度だけ表示されます。後で取得することはできません。']} translations.11
    • 有効期限設定 (任意) — 有効期限が切れる日を選択してください。組織が強制的に有効期限を設定するポリシーを適用している場合があります。
API 名称、安全キーオプション、有効期限のキーケース

  1. Select an 組織役割 — この設定は、キー全体の組織の基本的な権限を定義します。利用可能なロールは、自分のロールのレベルに依存します:

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

  2. パブリックAPIを通じて組織を作成する必要がある場合、有効にします。 組織を作成することを許可します。.

    この機能は、全体的な org.create 許可権を追加します。キーがAdmin組織ロールを持っている場合にのみ利用可能です。このキーが新しい組織を作成すると、Capgoは自動的に新しい組織にSuper Adminとしてキーを割り当てます。

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

    • 「+アプリを追加」 をクリックしてアプリ選択画面を開きます。 1つ以上のアプリを選択し、それぞれにロールを割り当てます:
    • アプリリーダー
      • — アプリに読み取り専用のアクセス権限を付与します。 許可権
      • App Uploader —
      • アプリアップローダー —
      • アプリ開発者 —
アプリ管理者

  1. RBACロールの選択 Click.

  2. “Create” セキュアキーが生成されました。 コピーしてください。

One-time API key secret modal with copy button

API keyの管理方法（編集）

API keyの管理方法（編集）

リスト内のRBACキー（Manage）に表示されている「」アイコンをクリックします。 (Manage) をクリックすると、リスト内のRBACキーを選択して、キー詳細ページを開くことができます。 キー名の変更

  • 組織ロールの更新 有効/無効の切り替え.
  • 組織の作成を許可する __CAPGO_KEEP_0__ keyの管理方法（編集）.
  • __CAPGO_KEEP_0__ keyの管理方法（編集） __CAPGO_KEEP_0__ keyの管理方法（編集） __CAPGO_KEEP_0__の場合、管理者組織ロールが設定されている場合。
  • Add, remove, or change アプリごとのロール.

Click “Save Changes” __CAPGO_KEEP_0__キー編集ページに現在のロール設定が表示されます。

APIキーを再生成する方法

セクション「APIキーを再生成する方法」

API キーのシークレット値を再生成するには、リスト内の任意のキーで「refresh icon」をクリックします。

To regenerate the secret value of an API key, click the (Regenerate) on any key in the list. (Regenerate) on any key in the list.

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

  • 安全な(ハッシュ化された)キー用 : 新しいテキスト形式のキーがモーダル内で一度表示され、コピーする必要があります。テキスト形式のキー用
  • : キー値はサーバー側で再生成されます。 古いキー値を使用するすべての統合が即座に停止します。__CAPGO_KEEP_0__ キー再生成の確認

__CAPGO_KEEP_0__ キーを削除する方法

「API キーを削除する方法」のセクション

「API キーを削除する方法」のセクション

Section titled “How to delete an API key?”

__CAPGO_KEEP_0__ ゴミ箱アイコン (リスト内の任意のキー) に表示される「削除」ボタン。確認ダイアログで削除を確定します。

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

API キーの削除確認ダイアログ

古いキー

「古いキー」セクション

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

古いキー

古いキー (役割割り当てなしのキー) を見つけた場合、これらはモードベースのパーミッションシステム ( コンソール.capgo.app/ダッシュボード/アクセスキーこのページは廃止予定であり、将来のアップデートで削除される予定です。

続けて API キー

「続けて API キー」というセクション

Capacitor を使用している場合 API キー API キーを使用してダッシュボードと API の実行を計画する場合、API オーバービューと接続してください。 API オーバービュー API オーバービューの実装詳細については、API オーバービューを参照してください。 導入 導入の実装詳細については、導入を参照してください。 API キー APIの実装詳細についてのキーや デバイス __CAPGO_KEEP_0__の実装詳細についてのデバイス、そして バンドル __CAPGO_KEEP_0__の実装詳細についてのバンドル。