API Keys 管理¶

Guanceは、Open API を呼び出すことで、ワークスペース内のデータを取得・更新できます。API を呼び出す前に、認証情報として API Key を作成する必要があります。

API Key は、Guance Open API にアクセスするためのコアとなる認証情報です。リクエストヘッダーの DF-API-KEY フィールドで認証を行い、リクエストが属するワークスペースを特定します。

Open API の詳細なインターフェース一覧については、Open API を参照してください。

前提条件¶

• Guanceワークスペースの管理者または Owner 権限を持つユーザーである必要があります。
• 呼び出す API インターフェースに必要な権限範囲を理解し、適切なロールを設定できるようにしておく必要があります。

API Key の作成¶

操作手順¶

1. Guanceワークスペースにアクセスし、左側のナビゲーションバーから管理 > API Key 管理を選択します。
2. 右上のKey を作成ボタンをクリックします。

3. 表示されたダイアログで、以下の項目を設定します。

   • 名前：API Key に付ける識別しやすい名前（最大 50 文字）
   • ロール：API Key に関連付けるロールを選択し、権限範囲を決定します
   • 備考：Key の用途を説明するメモ

4. 確定をクリックします。

ロールと権限のルール¶

1. Owner 専用 API Key の制限

• Owner アカウントのみが表示可能で、1 つだけ作成できます。

• 作成後、デフォルトでリストの先頭に固定表示されます。

• 他のロール（Administrator を含む）からは完全に非表示です。

2. 複数ロールの権限マージ

• 1 つの API Key に複数のロールを選択した場合、最終的な権限は選択したロールの権限の 和集合 となります。

• 最小権限の原則に従い、必要なロールのみを選択することを推奨します。

API Key の取得と使用¶

作成後、API Key リストページで API Key をクリックすると、詳細が表示されます。以下の情報が確認できます。

• Key ID：API Key の一意な識別子
• Key（シークレット）：API リクエストの認証情報

また、必要に応じて、現在の API Key の名前とロールを変更できます。

取得¶

API 認証方式¶

すべての Open API リクエストは、HTTP ヘッダーを使用して認証されます。