メインコンテンツにスキップ

API キー

API キーは、ロールベースのアクセス制御 (RBAC) で管理されます。各キーは組織全体のロールと任意のアプリ ロールを割り当てることができ、各キーがアクセスできるものを細かく制御できます。

Navigate to 組織 > API キー at console.capgo.app/settings/organization/api-keys.

ページには2つのセクションがあります:

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

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

APIを作成する方法について
  1. 上部のRBACキー表の ”+” ボタンをクリックしてください。

  2. キー情報 キー名:

    • (必須) — キー名の説明 (例: 「CI/CD Deploy」、「Monitoring Read-Only」) 安全なキーを作成
    • (オプション) — チェックすると、キーはサーバー側でハッシュ化されます。平文のキーは 1度だけ 作成後のみ表示されます。後で取得することはできません。 有効期限を設定
    • 期限 (optional) — __CAPGO_KEEP_0__ の有効期限を選択してください。組織が強制的な有効期限をポリシーで適用している場合があります。
API の作成フォームに名前、セキュアキー、有効期限を指定します。
  1. Select an 組織役割 — この設定は、キー全体の基本的な権限を定義します。組織内の役割によって、以下のロールが利用可能です:

    • None — 組織全体へのアクセス権限がなく、キーは個別に割り当てられたアプリにのみアクセスできます。
    • Member — 組織の基本的な読み取り権限を持ちます。
    • Admin — 組織全体の完全な管理権限を持ち、すべてのアプリへのアクセス権限を継承します。
  2. キーが API での組織の作成を必要とする場合は、有効 組織を作成することを許可する.

    この機能は、キーがAdmin組織ロールを持つ場合にのみ利用可能です。キーが新しい組織を作成すると、__CAPGO_KEEP_0__はその新しい組織にキーを自動的にSuper Adminとして割り当てます。 org.create permission. It is available when the key has an Admin organization role. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

  3. ”+ アプリ追加”をクリックしてアプリ選択画面を開きます。 1 つ以上のアプリを選択し、それぞれにロールを割り当てます::

    • アプリ読み取り者 — アプリに読み取り専用のアクセス権を付与します。 アプリアップローダー
    • — アプリにアップロード権限を付与します。
      • アプリアップローダー — アプリにアップロード権限を付与します。
      • アプリアップローダー
      • アプリ開発者
      • アプリ管理者
RBACロールの選択(組織レベルとアプリレベル)
  1. クリック 「作成」.

  2. 「Create secure key」をチェックすると、モーダルウィンドウが表示されます。 秘密鍵をすぐにコピーしてください。 モーダルウィンドウを閉じると、秘密鍵を復元できません。

API

API を編集する方法は何ですか?

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

__CAPGO_KEEP_0__ キーの編集方法のセクションのタイトル 任意の RBAC キーをリストに表示し、(管理) をクリックします。 リスト内の任意の RBAC キーをクリックして (管理) を選択すると、キーの詳細ページが開きます。ここでは、以下の操作が可能です。

  • キーの名前を変更する キーの組織ロールを更新する.
  • キーの有効/無効を切り替える Admin の組織ロールを持つキーの場合、組織の作成を許可する/許可しない.
  • Admin の組織ロールを持つキーの場合、組織の作成を許可する/許可しない設定を切り替えることができます。 組織の作成を許可する/許可しない設定を切り替えることができます。 組織の作成を許可する/許可しない設定を切り替えることができます。
  • Add, remove, or change per-app roles.

Click “Save Changes” when done.

API key edit page with current role settings

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

A confirmation dialog will appear. After confirming:

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

__CAPGO_KEEP_0__ キーを削除する方法

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

How to delete an API key?

API

__CAPGO_KEEP_0__ __CAPGO_KEEP_0__ (リスト内の任意のキーを削除) を確認するダイアログ

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

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

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

console.__CAPGO_KEEP_0__.app/dashboard/apikeys

Delete console.capgo.app/dashboard/apikeys. このページは廃止予定であり、将来のアップデートで削除されます。

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