メインコンテンツにジャンプ
Capgo - Capacitor アプリ向けライブ更新 Capgo

API キー

API キーはロールベースのアクセス制御（RBAC）を使用します。キーは組織全体のロール、またはアプリ固有のバインディング、または両方を持つことができます。すべてのアプリのバインディングは、その所有する組織に関連付けられます。最小権限のために、キーを選択したアプリに制限するのではなく、組織全体のロールを割り当てるのではなく、代わりにアプリ固有のバインディングを使用することをお勧めします。

API キーはどこで管理されますか。

「API キーはどこで管理されますか？」というセクションのタイトル。

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

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

  • RBAC キー — ロールが割り当てられたキー（推奨）。これらのキーは新しいロールベースの許可システムを使用します。
  • レガシーキー — 古いキーが使用されているキー（古いモードベースのシステム）read, upload, write, allロール割り当てなし。
API キーのリストページ（RBACとLegacyのセクションを表示）

新しいAPI キーを作成する方法

セクション：新しいAPI キーを作成する方法

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

  2. キーの情報を入力します。 キーの名前:

    • (必須) — キーの説明ラベル（例：「CI/CD Deploy」または「Monitoring Read-Only」） 安全なキーの作成
    • (任意) — チェックすると、キーのハッシュがサーバー側で行われます。平文のキーサイト __CAPGO_KEEP_0__ keys list page showing RBAC and Legacy sections 一度だけ 作成後は取り戻すことができません。
    • 有効期限の設定 (任意) — 有効期限が切れる日を選択してください。組織が有効期限を強制するポリシーを設定している場合があります。
APIのキー生成フォーム（名前、安全なキー、有効期限の選択）

  1. キー範囲の選択:

    • 組織全体へのアクセス 組織全体へのアクセスを選択する 組織の役割 組織全体の基準となる権限を定義します。利用可能なロールは、自分のロールのレベルに依存します:
      • なし 組織全体へのアクセスなし
      • メンバー — 組織の基本的な読み取り権限。
      • 管理者 — 組織とそのすべてのアプリケーションへの完全な管理権限。
    • アプリケーション専用アクセス — 有効 このキーを選択したアプリに制限各アプリのバインドは、その所有する組織に関連付けられます。このモードでは、組織全体のRBACロールのみが省略されます。

  2. キーがパブリックAPIを介して組織を作成する必要がある場合、有効にします 組織の作成を許可.

    この機能は、グローバル org.create 許可を追加します。キーは組織スコープも必要です org_admin または org_super_admin ダッシュボードで Admin を作成すると org_admin キーが新しい組織を作成した場合、Capgoはその新しい組織に自動的にキーをSuper Adminとして割り当てます。

  3. アプリにアクセスを許可するには:

    • このキーが新しい組織を作成した場合、__CAPGO_KEEP_0__はその新しい組織に自動的にキーをSuper Adminとして割り当てます。 このキーを選択したアプリに限定する が有効になっている場合、選択した組織の下の を選択してアプリを表示します。 選択したアプリのバインディングは、所有する組織と関連付けられます。このフィルターは組織全体のアクセスを許可しません。
    • クリック ”+ アプリを追加”, アプリを 1 つ以上選択し、それぞれに役割を割り当てます:
      • アプリ読者 — アプリに読み取り専用のアクセス権限があります。
      • アプリアップローダー — 新しいバンドルをアップロードできます。
      • アプリ開発者 — バンドルをアップロード、デバイスを管理、ネイティブ ビルドをトリガー、チャネル設定を更新できます。
      • アプリ管理者 — アプリにフル アクセス権限があります。
      • アプリプレビュー — CI/CD ライフサイクルをプレビュー: バンドルをアップロードし、プレビュー チャネルを作成します。チャネルは、このキーに対して自動的に、チャネル スコープのライフサイクル権限を受け取ります。

  4. Click 「作成」.

  5. あなたがチェックした場合 安全な鍵を作成、モーダルが平文の鍵を表示します。 コピーするにはすぐに — 鍵はモーダルを閉じた後は取得できません。

APIの1回限りの鍵シークレットモーダルにコピーボタン

プレビューワークフロー用のアプリプレビュー鍵を使用

プレビューワークフロー用のアプリプレビュー鍵を使用のセクション

使用 アプリプレビュー CIで作成される非公開のプレビュー チャンネル、パッケージのアップロード、プロモーション、チャンネルとパッケージの削除を行うツールがあります。既存のデフォルトまたはメインチャンネルへのライフサイクルアクセスはありません。

  1. RBACキーを作成し、有効化する 選択したアプリに制限する.
  2. 下 組織をフィルタリングするアプリ, 選択した組織を表示するために組織を選択します。各選択されたアプリは所有する組織と関連付けられます。
  3. プレビュー デプロイ用にのみ使用するアプリを追加します。
  4. 選択 アプリ プレビュー 選択したアプリごとに
  5. セキュアなキーを作成し、有効期限を設定し、CIシークレット マネージャーに保存する

選択したアプリのみを対象とするモードでは、組織全体のロールを省略します。 組織の関連付けを削除しないでください。 各 app_preview バインディングは、選択したアプリにスコープされており、そのアプリの所有する組織に関連付けられています。

許可権限と境界
app_preview 選択したアプリapp.read, app.read_bundles, app.upload_bundle、および app.create_channel.
自動 channel_preview バインディングこのキーがチャネルを作成するときに、Capgoは自動的にそのキー channel.read, channel.promote_bundle、および channel.delete そのチャネルにのみ適用されます。

app_preview __CAPGO_KEEP_0__ app.read, so the key may enumerate channel metadata in the selected app. The automatic child binding is a management __CAPGO_KEEP_0__はアプリのプレビュー用にバンドルをアップロードしたApp Previewキーを記録します。

Capgoは、自身が作成したプレビュー チャンネルごとに、自身のバンドルを設定し、バンドルとそのチャンネルを共に削除できます。

__CAPGO_KEEP_0__は、既存のデフォルトまたはメインチャンネル、別のプレビュー キーによって作成されたチャンネル、または別のキーのバンドルに対してはチャンネル バインディングを受信できません。

CIジョブの場合、プルリクエストごとにユニークなチャンネル名を使用してください。
APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"


npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"


npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

For a new channel, bundle upload --channel __CAPGO_KEEP_0__は新しいチャンネルを作成し、バンドルをアップロードし、1つのフローでプレビュー チャンネルをプロモートします。 __CAPGO_KEEP_0__は、キーがプレビュー チャンネルとそのリンクされた、共有されていないバンドルを所有している場合にのみ成功します。 プレビュー bundle.delete__CAPGO_KEEP_0__

__CAPGO_KEEP_0__ __CAPGO_KEEP_0__ __CAPGO_KEEP_0__

How to manage (edit) an API key?

API キーの管理方法

Click the 工具アイコン (Manage) on any RBAC key in the list. This opens the key detail page where you can:

  • キー名の変更 組織名の更新.
  • 組織ロールの変更 組織の作成を許可する.
  • Admin組織ロールの場合、キーが有効な場合にのみ組織を作成できます。 __CAPGO_KEEP_0__ キーの管理方法 __CAPGO_KEEP_0__ キーの詳細ページ
  • アプリごとにロールを追加、削除、変更 各アプリのロール設定.

クリック 「変更を保存」 完了したら。

API キーの編集ページに現在のロール設定が表示されます

API キーを再生成する方法

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

API キーのシークレット値を再生成するには、リスト内の任意のキーの隣にある リフレッシュアイコン (再生成)

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

  • For secure (hashed) keys: A new plain-text key is generated and displayed once in a modal. Copy it immediately.
  • For plain keys: The key value is regenerated server-side.

__CAPGO_KEEP_0__

API key regeneration confirmation

How to delete an API key?

Section titled “How to delete an API key?”

__CAPGO_KEEP_0__ trash icon (削除) をリスト内の任意のキーで確認します。

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

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

古いキー

「古いキー」セクションのタイトル

古いキーが見られる場合は、 古いキー セクション (役割割り当てなしのキー) (read, upload, write, all) です。これらは、モードベースのパーミッションシステム (

) を使用しています。まだ機能しますが、RBAC の細かいパーミッションの利点を受けることはできません。

古いキーはリストから再生成および削除できますが、RBAC ロールを追加するために編集することはできません。新しい RBAC キーを作成し、古いキーを削除することを推奨します。 古いキーを直接管理する必要がある場合は、まだ「console.capgo.app/dashboard/apikeys」でアクセスできます。このページは廃止予定であり、将来のアップデートで削除されます。

API キーから続けてください

API キーから続けてくださいというセクションのタイトル

あなたが使用している場合 API キー API キーを使用してダッシュボードの計画とAPI オペレーションを接続する場合、API オーバービューと接続してください API オーバービューの実装詳細については、API オーバービューを参照してください API オーバービューの実装詳細については、API オーバービューを参照してください 導入 導入の実装詳細については、導入を参照してください API キー API キーの実装詳細については、API キーを参照してください デバイス デバイスの実装詳細については、 バンドル バンドルの実装詳細については、