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

API キー

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

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

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

__CAPGO_KEEP_2__に移動してください。 __CAPGO_KEEP_2__ > 組織 > API キー __CAPGO_KEEP_3__ console.capgo.app/settings/organization/api-keys.

__CAPGO_KEEP_0__ キーは2つのセクションで表示されます。

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

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

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

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

  2. RBACキー情報 キー名:

    • (必須) — キー名(例:「CI/CD Deploy」または「Monitoring Read-Only」) __CAPGO_KEEP_0__
    • 安全なキーを作成 (任意) — チェックすると、キーはサーバー側でハッシュ化されます。平文のキーは作成後に一度だけ表示され、以降は取得できません。 期限を設定 (任意) — 有効期限を選択すると、キーはその日以降使用できなくなります。組織が強制的に期限を設定するポリシーを設定している場合があります。
    • __CAPGO_KEEP_0__のキー作成フォーム キー範囲を選択
API key creation form with name, secure key option, and expiration

  1. — 以下の

    • 組織役割 を選択して、組織全体の基本的な権限を定義します。利用可能なロールは、自分のロールのレベルに依存します: — 以下の ロール
      • なし — 組織全体へのアクセス権がない
      • メンバー — 組織への基本的な読み取りアクセス
      • 管理者 — 組織とそのすべてのアプリへの完全な管理権限
    • アプリのみのアクセス — 有効にする このキーを選択したアプリに制限各アプリのバインドは、その所有する組織に関連付けられ続ける; このモードでは、組織全体の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. 許可が付与されます。キーには組織スコープも必要です。

    • 許可が付与されます。キーには組織スコープも必要です。 新しい組織を作成すると、__CAPGO_KEEP_0__は自動的にキーをその新しい組織にスーパーアドミンとして割り当てます。 アプリにアクセスを許可するには: Limit this key to selected apps そのアプリを表示するには。選択されたアプリのバインドは、所有する組織に関連付けられます。このフィルタは、組織全体のアクセス権を付与しません。
    • クリック ”+ Add App”アプリを選択し、役割を割り当てる
      • アプリ リーダー アプリ リーダー — アプリに読み取り専用のアクセス権
      • アプリ アップローダー アプリ アップローダー — 新しいバンドルをアップロードできる
      • アプリ デベロッパー アプリ デベロッパー — バンドルをアップロード、デバイスを管理、ネイティブ ビルドをトリガー、チャネル設定を更新できる
      • アプリ アドミン アプリ アドミン — アプリにフル アクセス権
      • アプリ プレビュー — プレビュー CI/CD ライフサイクルをプレビューする: バンドルをアップロードし、プレビュー チャネルを作成します。 チャネルは、このキーのみに自動で、チャネル スコープのライフサイクル権限を受け取ります。

  4. クリック 「作成」.

  5. あなたがチェックした 作成するセキュア キー, その後モーダルが表示され、プレーン テキスト キーが表示されます。 すぐにコピーする — モーダルを閉じると、キーを取得できません。

一時的なAPI キー シークレット モーダルにコピー ボタン

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

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

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

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

This selected-apps-only mode omits an organization-wide role; it does not remove the organization association. Each app_preview binding remains scoped to its selected app and that app’s owning organization.

GrantPermissions and boundary
app_preview on the selected appapp.read, app.read_bundles, app.upload_bundle, and app.create_channel.
Automatic channel_preview contextbinding When this key creates a channel, Capgo automatically gives the key channel.read, channel.promote_bundle、および channel.delete そのチャンネルにのみ対して。

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

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

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なので、任意のバンドルを削除することはできません。

See the アクセス制御リファレンス 全体の境界のため

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

「API キーの編集方法」セクション

リスト内のRBACキーで任意のところに 工具アイコン (管理)をクリックすると、キー詳細ページが開きます。ここで、以下のことができます:

  • キー名の変更 組織ロールの更新.
  • 有効/無効の切り替え __CAPGO_KEEP_0__.
  • __CAPGO_KEEP_0__ 組織の作成を許可する __CAPGO_KEEP_0__ キーが管理者組織ロールを持つ場合
  • 追加、削除、または変更 アプリごとのロール.

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

API キーを再生成する方法

「API キーを再生成する方法」

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

To regenerate the secret value of an API key, click the アプリごとのロール (リスト内の任意のキーを再生成します。)

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

  • For 安全な(ハッシュ化された)キー : 新しいテキストキーがモーダル内で一度表示され、コピーする必要があります。
  • For テキストキー : サーバー側でキー値を再生成します。

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

API キー再生成の確認

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

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

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

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

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

古いキー

セクションのタイトル “古いキー”

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

古いキーは、古いモードベースのパーミッションシステムを使用しています (

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

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

セクション「API キーから続けてください」

__CAPGO_KEEP_0__ を使用している場合 API キー API キーと連携してダッシュボードと API の実装詳細を確認するには API オーバービュー API オーバービュー 実装詳細 実装詳細 API キー API キーの実装詳細のため デバイス デバイスの実装詳細のため、 バンドル バンドルの実装詳細のため、