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

API キー

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

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

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

__CAPGO_KEEP_0__キーを管理するには、次の手順に従ってください。 API > 組織 > API キー __CAPGO_KEEP_0__.app/settings/organization/__CAPGO_KEEP_1__-keys console.capgo.app/settings/organization/api-keys.

RBAC キー

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

API キーを作成する方法

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

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

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

    • キー情報 キー名（必須）— キーに付ける説明ラベル（例：CI/CD DeployまたはMonitoring Read-Only）
    • 安全なキーを作成 (任意) — チェックすると、キーはサーバー側でハッシュ化されます。平文のキーは作成後に一度だけ表示され、後で取得することはできません。 キーが作成された後 キーが作成された後
    • キーが作成された後 期限を設定
API key creation form with name, secure key option, and expiration

  1. __CAPGO_KEEP_0__ キー作成フォーム

    • キー範囲を選択 組織全体へのアクセス — 以下の 組織役割
      • なし — 組織全体へのアクセス権がない
      • メンバー — 組織への基本的な読み取りアクセス
      • 管理者 — 組織とそのすべてのアプリへの完全な管理権限
    • アプリのみのアクセス — 有効 このキーを選択したアプリに制限各アプリのバインドは、その所有する組織に関連付けられます。このモードでは、組織全体のRBACロールのみを除外します。

  2. APIで組織を作成する必要がある場合のキー 組織を作成することを許可する.

    グローバルに許可を追加します。 org.create 許可も組織スコープの org_admin または org_super_admin 許可を追加します。 許可も組織スコープの または org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

  3. 許可も組織スコープの

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

  4. クリック 「作成」.

  5. チェックした場合 セキュア キーを作成, モーダルが表示され、プレーン テキスト キーが表示されます。 すぐにコピーしてください — モーダルを閉じると復元できません。

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

プレビュー ワークフローでアプリ プレビュー キーを使用します

セクション「プレビュー ワークフローでアプリ プレビュー キーを使用します」

使用 アプリプレビュー CI用に、非公開のプレビューチャネルを作成し、バンドルをアップロードしてプロモートし、チャネルとバンドルを両方削除します。既存のデフォルトまたはメインチャネルへのライフサイクルアクセスはありません。

  1. RBACキーを作成し、有効化 このキーを選択したアプリに制限.
  2. 以下 組織をフィルタするアプリを選択,選択した組織を表示するために組織を選択します。各選択したアプリは、所有する組織と関連付けられます。
  3. プレビュー展開用にのみ使用するアプリまたはアプリを追加してください。
  4. 選択 アプリプレビュー 各選択したアプリに
  5. 安全なキーを作成し、適切な場合は有効期限を設定し、CIシークレットマネージャーに保存してください。

選択したアプリのみを対象とするこのモードでは、組織全体のロールを省略しますが、それは組織の関連付けを削除しません。各バインディングは、選択したアプリとその所有する組織にスコープが設定されます。 許可を付与し、選択したアプリの境界を設定し、 自動 app_preview チャネルを作成するキーの場合、__CAPGO_KEEP_0__は自動的にキーに

許可境界
app_preview アプリapp.read, app.read_bundles, app.upload_bundle、 app.create_channel.
自動 channel_preview チャネルを作成するキーの場合、__CAPGO_KEEP_0__は自動的にキーにWhen this key creates a channel, Capgo automatically gives the key channel.read, channel.promote_bundle、そして channel.delete そのチャンネルにのみ対して。

app_preview 保持する app.read、したがって、キーは選択したアプリのチャンネルメタデータを列挙するためにキーを使用できます。自動子バインディングは、キーが作成しなかったチャンネルに対してライフサイクル変化を許可しません。 管理 境界: そのチャンネルに対するライフサイクル変化を許可しません。

Capgo も、App Preview キーがアップロードしたバンドルの情報を記録します。キーは、各プレビュー チャンネルで自分自身のバンドルを設定し、バンドルとそのチャンネルを一緒にクリーンアップできます。既存のデフォルトまたはメイン チャンネル、別のプレビュー キーによって作成されたチャンネル、または別のキーのバンドルに対してはチャンネル バインディングを受け取ることはできません。

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

新しいチャンネルの場合 bundle upload --channel チャンネルを作成し、バンドルをアップロードし、1 つのフローでプロモートします。最後のコマンドは、キーがプレビュー チャンネルとそのリンクされた、共有されていないバンドルを所有している場合にのみ成功します。 アプリプレビュー まだ一般的なものではありません bundle.deleteなので、任意のバンドルを削除することはできません。

https://capgo.com/docs/webapp/api-keys/ アクセス制御リファレンス 全体の境界のため

API キーの編集方法はどれですか?

「API キーの編集方法」

任意のRBAC キーの一覧で 道具のアイコン (管理)をクリックすると、キーの詳細ページが開きます。ここで、以下の操作が可能です。

  • キーの名前を変更 組織の役割を更新.
  • 有効/無効を切り替え wrench icon.
  • (Manage) on any RBAC key in the list. 組織の作成を許可する キーが管理者組織ロールを持つ場合にのみ
  • 追加、削除、または変更 アプリごとのロール.

変更を保存する 完了したら __CAPGO_KEEP_0__ キーの編集ページに現在のロール設定が表示されます

API キーを再生成する方法

API キーを再生成する方法

API キーのシークレット値を再生成するには、

To regenerate the secret value of an API key, click the refresh アイコンをクリックしてください リスト内の任意のキーをクリックして再生成します。

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

  • For セキュア(ハッシュ化)キー: 新しいテキスト形式のキーがモーダルウィンドウで一度表示され、すぐにコピーしてください。
  • For プランキーのキー: サーバーサイドでキー値を再生成します。

古いキー値を使用するすべての統合が即座に停止します。

API キー再生成の確認

はじめに API キーを削除する方法

「はじめに API キーを削除する方法」

リスト内の任意のキーをクリックして、 ゴミ箱のアイコン (削除) をクリックします。確認ダイアログで削除を確定します。

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

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

古いキー

「古いキー」というセクション

古いキー (役割割り当てなしのキー) をリスト内で見つけた場合、これらは古いモードベースの許可システムを使用しています ( 古いキー セクションread, upload, write, all古いキーはリストから再生成および削除できますが、RBAC ロールを追加するために編集することはできません。RBAC キーを作成し、古いキーを削除することをお勧めします。

Legacy keys can be regenerated and deleted from the list, but cannot be edited to add RBAC roles. We recommend creating new RBAC keys and deleting legacy keys when possible.

必要な場合は、古いキーを直接管理するには、まだアクセスできます。 console.capgo.app/dashboard/apikeysこのページは廃止され、将来のアップデートで削除されます。

続けるにはAPI キーをクリックしてください。

セクション「続けるにはAPI キーをクリックしてください」

Capgoを使用している場合 API キー API キーを使用してダッシュボードとCapgoの操作を計画している場合、Capgo Overviewと接続してください。 API Overview for the implementation detail in API Overview, 導入 導入の実装詳細については導入を参照してください。 API キー API キーの実装詳細のため デバイス デバイスの実装詳細のため、 バンドル バンドルの実装詳細のため、