API キーで API アクセスを制限する

API キーを使用すると、特定の API メソッドまたは API のすべてのメソッドに対するアクセスを制限できます。このページでは、API キーのあるクライアントに対する API アクセスの制限方法と API キーの作成方法について説明します。

Extensible Service Proxy(ESP) は Service Control API を使用して、API キーと、その API キーとプロジェクトで有効にされた API との関連付けを検証します。API キーを必須とするように API が設定されている場合は、保護されたメソッド、クラス、API へのリクエストは適切なキーがない限り拒否されます。適切なキーとは、プロジェクト内で生成されたものか、API を有効にする権限を付与されたデベロッパーに属する別のプロジェクトで生成されたもののことです。 API キーがどのプロジェクトで作成されたかはログに記録されず、リクエスト ヘッダーにも追加されません。ただし、特定のコンシューマ プロジェクトのフィルタリングに記載されているとおり、クライアントが関連付けられている Google Cloud プロジェクトは、[エンドポイント] の [サービス] に表示されます。

API キーの作成が必要な Google Cloud プロジェクトについては、API キーにより保護されている API を共有するをご覧ください。

すべての API メソッドへのアクセスを制限する

API のすべてのメソッドへのアクセスに API キーを要求するには:

  1. テキスト エディタでプロジェクトの openapi.yaml ファイルを開きます。

  2. サンプルコード スニペットに示されているように、securityDefinitions: に、apiKeykeyquery といった api_key: 値を追加します。

    securityDefinitions:
      # This section configures basic authentication with an API key.
      api_key:
        type: "apiKey"
        name: "key"
        in: "query"

    これにより、api_key という「セキュリティ スキーム」が確立され、API の保護に使用できるようになります。 その他の api_key 定義オプションについては、API キー定義の制限事項をご覧ください。

  3. ファイルのトップレベル(インデントやネストのないレベル)にある security ディレクティブに api_key: [] を追加します。security ディレクティブはすでに存在する場合もありますが、追加する必要がある場合もあります。

      security:
        - api_key: []
    

    このディレクティブを使用すると、api_key セキュリティ スキームがファイル内のすべてのメソッドに適用されます。角かっこの中には何も入れないでください。OpenAPI 仕様では、OAuth を使用しないセキュリティ スキームの場合は空のリストが必要です。

特定の API メソッドへのアクセスを制限する

特定のメソッドの API キーを取得するには:

  1. テキスト エディタでプロジェクトの openapi.yaml ファイルを開きます。

  2. ファイルのトップレベル(インデントやネストのないレベル)に空のセキュリティ ディレクティブを追加して、API 全体にこのディレクティブを適用します。

    security: []
    
  3. サンプルコード スニペットに示されているように、securityDefinitions: に、apiKeykeyquery といった api_key: 値を追加します。

    securityDefinitions:
      # This section configures basic authentication with an API key.
      api_key:
        type: "apiKey"
        name: "key"
        in: "query"

    これにより、api_key という「セキュリティ スキーム」が確立され、API の保護に使用できるようになります。 その他の api_key 定義オプションについては、API キー定義の制限事項をご覧ください。

  4. メソッドの定義の security ディレクティブに api_key: [] を追加します。

    ...
    paths:
      "/echo":
    post:
      description: "Echo back a given message."
      operationId: "echo"
      security:
      - api_key: []
      produces:
      ...
    

    このディレクティブを使用すると、api_key セキュリティ スキームがこのメソッドに適用されます。角かっこの中には何も入れないでください。OpenAPI 仕様では、OAuth を使用しないセキュリティ スキームの場合は空のリストが必要です。

メソッドの API キー制限を削除する

API のアクセスを制限している場合に、特定のメソッドについてのみ API キー検証を無効にするには:

  1. テキスト エディタでプロジェクトの openapi.yaml ファイルを開きます。

  2. メソッドの定義に、空の security ディレクティブを追加します。

    ...
    paths:
      "/echo":
    post:
      description: "Echo back a given message."
      operationId: "echo"
      security: []
      produces:
      ...
    

API キーを使って API を呼び出す

API または API メソッドで API キーが必要とされる場合、次の curl の例に示すように、key というクエリ パラメータを使用してキーを提供します。

 curl "${ENDPOINTS_HOST}/echo?key=${ENDPOINTS_KEY}"

ここで、ENDPOINTS_HOST は API ホスト名を格納する環境変数、ENDPOINTS_KEY は API キーを格納する環境変数です。

API キーにより保護されている API を共有する

API キーは、作成された Google Cloud プロジェクトに関連付けられます。API で API キーを必須とするように設定すると、API キーが作成される Google Cloud プロジェクトは、次の質問に対する回答によって異なります。

  • API の個々の呼び出し元を互いに区別して、割り当てなどの Endpoints 機能を使用できるようにする必要があるか。
  • API のすべての呼び出し元に独自の Google Cloud プロジェクトがあるか。
  • 異なる API キー制限を設定する必要があるか。

どの Google Cloud プロジェクトで API キーを作成するかを決定するためのガイドとして、以下のディシジョン ツリーを使用できます。

API キー ディシジョン ツリー

API を有効にする権限を付与する

API の呼び出し元を区別する必要があり、呼び出し元ごとに独自の Google Cloud プロジェクトがある場合、各自の Google Cloud プロジェクトで API を有効にできるように、呼び出し元のプロジェクト メンバーに権限を付与できます。これにより、ユーザーは API で使用するキーを各自で作成できます。

たとえば、社内のクライアント プログラムに独自の Google Cloud プロジェクトが関連付けられ、これらのプログラムが使用する API を作成しているとします。API の呼び出し元を区別するには、各呼び出し元の API キーをそれぞれの Google Cloud プロジェクトで作成する必要があります。この場合、クライアント プログラムの Google Cloud プロジェクトで API を有効にする権限をプロジェクトのメンバーに付与します。

ユーザーが独自の API キーを作成できるようにするには:

  1. API が構成されている Google Cloud プロジェクトで、API を有効にする権限を各ユーザーに付与します。
  2. 各ユーザーと連絡を取り、ユーザーの Google Cloud プロジェクトで API を有効化し、API キーを作成できるようになったことを知らせます。

呼び出し元ごとに個別の Google Cloud プロジェクトを作成する

API の個々の呼び出し元を区別する必要がある場合、すべての呼び出し元が Google Cloud プロジェクトを持っているとは限らない状況では、呼び出し元ごとに個別の Google Cloud プロジェクトと API キーを作成できます。プロジェクトを作成する前に、プロジェクトに関連付けられた呼び出し元を簡単に識別できるようにプロジェクト名について考慮してください。

たとえば、API を利用する外部ユーザーがあり、API を呼び出すクライアント プログラムの作成方法がわからないとします。たとえば、Google Cloud サービスを使用しているクライアントに Google Cloud プロジェクトがある場合もあれば、存在しない場合もあります。個々の呼び出し元を区別するには、呼び出し元ごとに個別の Google Cloud プロジェクトと API キーを作成する必要があります。

呼び出し元ごとに個別の Google Cloud プロジェクトと API キーを作成するには:

  1. 呼び出し元ごとに個別のプロジェクトを作成します。
  2. 各プロジェクトで、API を有効化して API キーを作成します。
  3. それぞれの呼び出し元に API キーを付与します。

呼び出し元ごとに API キーを作成する

API の呼び出し元を区別する必要はないものの、API キーの制限を追加する必要がある場合は、同じプロジェクト内で呼び出し元ごとに個別の API キーを作成できます。

同じプロジェクト内で呼び出し元ごとに API キーを作成するには:

  1. API が構成されているプロジェクトまたは API が有効化されているプロジェクトで、API キー制限が必要なユーザーごとに API キーを作成します。
  2. それぞれの呼び出し元に API キーを付与します。

すべての呼び出し元に同じ API キーを作成する

API の呼び出し元を区別する必要も、API の制限を追加する必要もないが、(匿名アクセスを防ぐなどの目的で)API キーを要求する場合は、すべての呼び出し元が使用する 1 つの API キーを作成できます。

すべての呼び出し元に同じ API キーを作成するには:
  1. API が構成されているプロジェクトまたは API が有効になっているプロジェクトで、すべての呼び出し元に使用する API キーを作成します。
  2. すべての呼び出し元に同じ API キーを付与します。

次のステップ