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

このページは Apigee と Apigee ハイブリッドに適用されます。

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

このページでは、Apigee Management API を使用してセキュリティ アクションを管理する方法について説明します。制限事項やレイテンシなどのセキュリティ アクション機能の概要については、セキュリティ アクションの概要と UI をご覧ください。

すべてのセキュリティ アクション機能には、Apigee Management API を通じてアクセスできます。使用可能なすべてのコマンドについては、セキュリティ アクション API リファレンスをご覧ください。このページでは、使用可能なコマンドの例をいくつか示します。

例で使用されている変数

このページの例には、次の変数が含まれる場合があります。

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

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

このセクションでは、さまざまなアクション タイプのセキュリティ アクションを作成する方法の例を示します。

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

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

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Authorization: Bearer $TOKEN" \
       -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 -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
       -H "Authorization: Bearer $TOKEN" \
       -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 -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Authorization: Bearer $TOKEN" \
       -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 は、他のアクション タイプの編集にも対応しています。

update_mask には、description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,*（すべて）のいずれかのオプションを指定できます。省略した場合、デフォルトで「すべて」になります。

アクションの編集時に使用できる値について詳しくは、セキュリティ アクション API リファレンス ドキュメントをご覧ください。

  curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME?update_mask=deny,condition_config" \
         -H "Authorization: Bearer $TOKEN" \
         -d '{"deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}' \
         -H "Content-Type: application/json"
         {
           "name": "ACTION_NAME",
           "state": "ENABLED",
           "createTime": "2022-12-29T18:28:50Z",
           "updateTime": "2022-12-29T18:28:50Z",
           "conditionConfig": {
             "ipAddressRanges": [
               "100.0.230.0"
             ]
           },
           "deny": {
             "responseCode": 404
           }
         }

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

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

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

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

curl -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"
       -H "Authorization: Bearer $TOKEN"

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

{
      "name": "ACTION_NAME",
      "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 -X POST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"
       -H "Authorization: Bearer $TOKEN"

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

{
      "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 -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"
       -H "Authorization: Bearer $TOKEN"

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

{
      "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 -X GET "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"
       -H "Authorization: Bearer $TOKEN"

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

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

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

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

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

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

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

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

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

curl -X PATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
       -H "Authorization: Bearer $TOKEN" \
       -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"
}

セキュリティ アクションを削除する

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

curl -X DELETE "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"
       -H "Authorization: Bearer $TOKEN"