セキュリティ アクション API

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

Apigee UI でセキュリティ アクションを使用するだけでなく、Apigee API を通じてすべてのセキュリティ アクション機能も使用できます。

セキュリティ アクションの制限

セキュリティ アクションは、Apigee 環境レベルで適用されます。環境ごとに、セキュリティ アクションには次のような制限があります。

  • 1 つの環境で一度に実行できるアクションは最大 1,000 個。
  • 各アクションに最大 5 つのフラグヘッダーを追加可能。

レイテンシ

セキュリティ アクションには、次のようなレイテンシがあります。

  • セキュリティ アクションを作成してから、そのアクションが有効になるまでに最大 10 分かかることがあります。アクションが有効になり、なんらかの API トラフィックに適用されると、セキュリティ アクションの詳細ページでアクションの効果を確認できます。注: アクションが有効になっていても、なんらかの API トラフィックに適用されていなければ、セキュリティ アクションの詳細ページで効果を確認することはできません。
  • セキュリティ アクションを有効にすると、API プロキシの応答時間がわずかに長くなります（2% 未満）。

セキュリティ アクションを作成する

次の例で、API 呼び出しを使用してセキュリティ アクションを作成する方法を説明します。すべての例で、次のようになります。

  • ORG は組織です。
  • ENV はセキュリティ アクション用の環境です。
  • ACTION_NAME はセキュリティ アクションの名前です。

拒否アクションを作成する

拒否アクションを作成するには、次のようにコマンドを入力します。

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.225.0"]}}'

これにより、ip_address_ranges の後にリストされる IP アドレスへのアクセスを拒否し、レスポンス コード 404 を返すセキュリティ アクションが作成されます。

フラグ アクションを作成する

フラグ アクションを作成するには、次のようにコマンドを入力します。

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
        -H "Content-Type: application/json" \
        -d '{"state": "ENABLED", "flag": {"headers": [{"name": "senseflag", "value": "flagvalue"}]}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}'

これにより、ip_address_ranges の後にリストされた IP アドレスからのリクエストにフラグを設定し、値 flagvalue を持つヘッダー senseflag を追加するセキュリティ アクションが作成されます。

許可アクションを作成する

許可アクションを作成するには、次のようなコマンドを入力します。

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
        -H "Content-Type: application/json" \
        -d '{"state": "ENABLED", "allow": {}, "condition_config": {"ip_address_ranges": ["100.0.220.0", "200.0.0.0"]}}'

このコマンドにより、ip_address_ranges の後にリストされた IP アドレスからのリクエストを許可するセキュリティ アクションが作成されます。

セキュリティ アクションを有効または無効にする

次の例で、セキュリティ アクションを有効または無効にする API 呼び出しについて説明します。

セキュリティ アクションを有効にする

セキュリティ アクションを有効にするには、次のようにコマンドを入力します。

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"

次のようなレスポンスが返されます。

{
      "name": "ACTION_ALLOW",
      "state": "ENABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:19:26.650965481Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
   }

セキュリティ アクションを無効にする

セキュリティ アクションを無効にするには、次のようにコマンドを入力します。

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"

次のようなレスポンスが返されます。

{
      "name": "actionallow",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04.874540001Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
   }

セキュリティ アクションを取得または一覧表示する

次の例で、セキュリティ アクションを取得または一覧表示する方法について説明します。

セキュリティ アクションを取得する

セキュリティ アクションを取得するには、次のようにコマンドを入力します。

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"

次のようなレスポンスが返されます。

{
      "name": "ACTION_NAME",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
    }

セキュリティ アクションを一覧表示する

すべてのセキュリティ アクションを一覧表示するには、次のようにコマンドを入力します。

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"

セキュリティ アクションを一時停止または再開する

次の例で、セキュリティ アクションを一時停止または再開する方法について説明します。

すべてのセキュリティ アクションを一時停止する

すべてのセキュリティ アクションを一時停止するには、次のようにコマンドを入力します。

curl -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -H "Content-Type: application/json" \
                -d '{"enabled": "false", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

次のようなレスポンスが返されます。

{
      "name": "organizations//environments/ENV/securityActionsConfig",
      "enabled": false,
      "updateTime": "2023-01-23T21:44:58.063807Z"
    }
}

一時停止したセキュリティ アクションを再開する

一時停止したセキュリティ アクションを再開するには、次のようにコマンドを入力します。

curl  -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -H "Content-Type: application/json" \
                -d '{"enabled": "true", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

次のようなレスポンスが返されます。

{
      "name": "organizations/ORG/environments/ENV/securityActionsConfig",
      "enabled": true,
      "updateTime": "2023-01-23T21:44:58.063807Z"
    }
}