API キー

このプラグインのインストール手順とフルマークダウンガイドを含む設定プロンプトをコピーする。

APIキーは、Capgo APIへの要求を認証するために使用されます。キーは組織固有であり、RBACロールを割り当てることで細かいアクセス制御が可能です。各キーには期限日付もオプションで設定でき、セキュアキー（ハッシュされたキー）として作成することも可能で、平文値は一度だけ表示されます。

Using an API key

Use the authentication header documented by the endpoint. For API-key requests, authorization 受け入れられる:

curl -H "authorization: YOUR_API_KEY" https://api.capgo.app/...

Cloudflare APIキーを使用する場合、チャンネル API 受け入れます authorization または capgkeyCapacitorライブアップデートの代替品の比較ページ

組織ロール

API keys use the same role-based access control (RBAC) system as user accounts. When creating or managing keys through the web app or API, you assign roles at two levels:

アプリごとの権限 、 org_admin 、 org_member).
__CAPGO_KEEP_0__キーは、ユーザーアカウントと同じロールベースアクセス制御(RBAC)システムを使用します。Webアプリまたは__CAPGO_KEEP_1__を通じてキーを作成または管理する際、2つのレベルでロールを割り当てます。 __CAPGO_KEEP_1__ app_admin, app_developer, app_uploader, app_readerRBAC権限 app_preview).

API キーが明示的なロールバインディングを持つ場合 許可チェックの評価にのみ使用される ロールバインディング

キー所有者の個人的な権限は、キーによって継承されない

「プレビューチャンネル自動化」 app_preview バインド

{
  "name": "PR preview key",
  "hashed": true,
  "bindings": [
    {
      "role_name": "app_preview",
      "scope_type": "app",
      "org_id": "<OWNING_ORG_UUID>",
      "app_id": "<APP_UUID>"
    }
  ]
}

org_id コピー app_id is the app record’s internal UUID, not the public app identifier used by CLI commands (for example, com.example.appアプリレコードの内部 UUID、__CAPGO_KEEP_0__ コマンドで使用されるパブリックアプリ識別子とは異なる

ロールバインディングは、キーが組織全体のロールを持たない場合でも組織に依存する app_preview ロールには、 app.read, app.read_bundles, app.upload_bundle, そして app.create_channel. そのキーがチャネルを作成すると、Capgoは新しく作成されたチャネルに自動的に channel_preview のバインディングを追加します。その子バインディングは channel.read, channel.promote_bundle, そして channel.delete のみを許可します。そのキーが作成したチャネル。

app_preview は app.read, したがって、この制限は厳密なチャネル読み取り隔離ではありません: キーは選択したアプリのチャネルメタデータを列挙できます。自動子バインディングは のライフサイクル変化を制限します。 __CAPGO_KEEP_0__は、各バンドルをアップロードしたApp Preview キーを記録します。キーは、自身のバンドルを各プレビューチャネルにアップグレードできます。ただし、既存のデフォルト/メインチャネル、別のプレビューキーによって作成されたチャネル、または別のキーのバンドルに対しては、チャネルライフサイクルアクセスはありません。このワークフローでは

Capgo records the App Preview key that uploaded each bundle. The key can promote only its own bundle to each preview channel it creates. It has no channel lifecycle access to an existing default/main channel, a channel created by another preview key, or another key’s bundle. For this workflow, omit public を使用しないでください。 --default.

使用 channel delete <preview-channel> <public-app-id> --delete-bundle キャッシュのクリア用に使用します。このルートは、所有権のチェックされた原子的なプレビュークリーンアップルートです。これは、呼び出し元のキーのプレビューチャネルとリンクされたバンドルだけを削除します。 app_preview 一般的な bundle.delete.

ダッシュボードのセットアップと完全なCLIの例については、アプリプレビューキーをプレビューワークフローに使用します。.

組織の作成権限

組織を作成するには、API キーを使用して明示的なグローバルパーミッションが必要です: org.create.

This permission is separate from normal org/app role bindings because a new organization does not exist yet when POST /organization/ API キーを使用して組織を作成するには:

API キーには org.create に含まれます。 global_permissions.
API キーには現在の組織スコープの org_admin または org_super_admin __CAPGO_KEEP_0__ キーには現在の組織スコープの
New API keys do not receive org.create __CAPGO_KEEP_0__ キーには現在の組織スコープの または API キーには現在の組織スコープの
既存の書き込み可能な組織管理者/管理者APIキーは、既存の統合が組織を作成し続けるようにバックフィルされました。 org.create 既存の統合が組織を作成し続けるようにするために、既存のキーがバックフィルされました。

APIキーが組織を作成すると、Capgoはその同じAPIキーを自動的に組織に割り当てます。 org_super_admin __CAPGO_KEEP_0__キーを__CAPGO_KEEP_1__で作成した場合、組織管理者バインディングと一緒に含める必要があります。

If you create an API key through the API, include global_permissions 組織を作成する場合にのみ適用されます。組織を削除するには、通常、ターゲット組織に削除権限が必要です。

{
  "name": "Provisioning key",
  "hashed": true,
  "bindings": [
    {
      "role_name": "org_admin",
      "scope_type": "org",
      "org_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "global_permissions": ["org.create"]
}

org.create セキュア (ハッシュ) キー org_super_admin.

セキュアキーを作成する場合、サーバーはキーマテリアルを生成し、平文値を一度だけ返します。ハッシュのみが保存されます。このため:

セキュア (ハッシュ) キー

セキュア (ハッシュ) キー 取得できません。 作成後。
再生成は、新しいテキストキー (一度表示) と、保存されたハッシュを更新します。
プロダクション用としては、ハッシュ化されたキーが推奨されます。

組織ポリシーを通じて、ハッシュ化されたキーが強制される場合があります。 enforce_hashed_api_keys 期限切れ

「期限切れ」

組織ポリシーで強制されることができます:

期限切れの強制

すべての新しいキーには、期限切れが必要です。 (require_apikey_expiration — すべての新しいキーには、期限切れが必要です。
最大有効期限 (max_apikey_expiration_days）— 有効期限は今からN日以内に至るまでに変更できません。

セキュリティのベストプラクティス

最小権限の原則: 最も制限が厳しいロールを割り当て、機能するようにするのに十分な権限が必要な場合
定期的なローテーション: API キーを定期的に再生成機能を使用してローテーションする
安全なストレージ: API キーを安全に保存し、バージョン管理にコミットしないように
ハッシュ化されたキーを使用: 生産環境の統合用に安全な（ハッシュ化された）キーを作成する
期限設定: 一律設定臨時或CI/CD存取用的キー
範囲制限: 限制キー到特定アプリに最小必要ロール

一般的な使用例

CI/CD統合: 特定のアプリに最小必要ロールを設定し、期限を設定 app_uploader または app_developer ロール、そして期限を設定
プレビューチャネル: 使用 app_preview CI環境では、バンドルをアップロードするためにプレビューアプリまたはアプリにのみ使用してください。
Deployment Automation: 自動デプロイスクリプト用にロールを使用するキーの使用 app_developer Monitoring Tools
: 外部監視統合用にロールを使用してキーコードを生成Admin Access app_reader : 管理ツール用にロールを使用するキーの使用は控えめに
Third-Party Integrations: 最小限のロールで特定のアプリに制限されたキーコードを作成 org_admin on only the preview app or apps when CI needs to upload a bundle, create a temporary channel, and atomically clean up its own channel and bundle.
Deployment Automation : Use keys with the
組織プロビジョニング: 使用する org_admin または org_super_admin Capacitorライブアップデートの代替手段を比較するページ。ロール: 長いマーケティングまたは法的文章。ページ: page alternatives.astro。 org.create Appflowの比較/移行マーケティングコピー。ロール: 長いマーケティングまたは法的文章。ページ: page ionic-appflow.astro。

Keep going from API Keys

Appflowの比較/移行マーケティングコピー。ロール: 短いUIラベルまたはナビゲーションアイテム。ページ: page ionic-appflow.astro、page ionic-enterprise-plugins.astro、page solutions/ionic-enterprise-plugins.astro。 API Keys 続きますから__CAPGO_KEEP_0__ キー @capgo/capacitor-social-login あなたがcapgo キーを使用して認証とアカウントフローの計画を行っている場合、@capgo/capacitor-social-loginに接続してください。 @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, 都当計終起突 Capgoの実装詳細について、都当計終起突、 SSO (Enterprise) Capgoの実装詳細について、SSO (Enterprise).