Security Actions API

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Halaman ini menjelaskan cara mengelola tindakan keamanan menggunakan Apigee Management API. Untuk ringkasan fungsi tindakan keamanan, termasuk batasan dan latensi, lihat Ringkasan dan UI tindakan keamanan.

Anda dapat mengakses semua fitur tindakan keamanan melalui Apigee Management API. Lihat referensi Security Actions API untuk mengetahui informasi tentang semua perintah yang tersedia. Halaman ini menampilkan contoh beberapa perintah yang tersedia.

Variabel yang digunakan dalam contoh

Contoh di halaman ini dapat mencakup variabel berikut:

  • ORG adalah organisasi.
  • ENV adalah lingkungan untuk tindakan keamanan.
  • ACTION_NAME adalah nama tindakan keamanan.

Membuat tindakan keamanan

Bagian ini memberikan contoh cara membuat tindakan keamanan dengan berbagai jenis tindakan.

Membuat tindakan penolakan

Untuk membuat tindakan penolakan, masukkan perintah yang mirip dengan berikut ini:

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"]}}'

Tindakan ini akan membuat tindakan keamanan yang menolak akses ke permintaan ke alamat IP yang tercantum setelah ip_address_ranges dan menampilkan kode respons 404.

Membuat tindakan tanda

Untuk membuat tindakan tanda, masukkan perintah yang mirip dengan berikut:

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"]}}'

Tindakan ini membuat tindakan keamanan yang menandai permintaan dari alamat IP yang tercantum setelah ip_address_ranges dan menambahkan header senseflag dengan nilai flagvalue.

Membuat tindakan izinkan

Untuk membuat tindakan izinkan, masukkan perintah yang mirip dengan berikut ini:

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"]}}'

Tindakan ini akan membuat tindakan keamanan yang mengizinkan permintaan dari alamat IP yang tercantum setelah ip_address_ranges.

Mengedit tindakan keamanan

Bagian ini memberikan contoh cara mengedit konfigurasi tindakan keamanan yang ada. Lihat Mengaktifkan atau menonaktifkan tindakan keamanan atau Menghapus tindakan keamanan untuk melihat contoh jenis perubahan tersebut.

Mengedit tindakan penolakan

Bagian ini menunjukkan contoh pengeditan tindakan penolakan. API ini juga mendukung pengeditan jenis tindakan lainnya.

update_mask dapat menyertakan salah satu opsi berikut: description,condition_config, api_proxies,expire_time,ttl,flag,allow,deny,* (semua), atau tidak ada (defaultnya adalah semua).

Lihat dokumentasi referensi Security Actions API untuk mengetahui informasi selengkapnya tentang kemungkinan nilai saat mengedit tindakan.

  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
           }
         }

Mengaktifkan atau menonaktifkan tindakan keamanan

Contoh berikut menunjukkan panggilan API untuk mengaktifkan atau menonaktifkan tindakan keamanan.

Mengaktifkan tindakan keamanan

Untuk mengaktifkan tindakan keamanan, masukkan perintah yang mirip dengan berikut ini:

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

Tindakan ini akan menampilkan respons seperti berikut:

{
      "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"
}

Menonaktifkan tindakan keamanan

Untuk menonaktifkan tindakan keamanan, masukkan perintah yang mirip dengan berikut ini:

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

Tindakan ini akan menampilkan respons seperti berikut:

{
      "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"
}

Mendapatkan atau mencantumkan tindakan keamanan

Contoh berikut menunjukkan cara mendapatkan atau membuat daftar tindakan keamanan

Mendapatkan tindakan keamanan

Untuk mendapatkan tindakan keamanan, masukkan perintah yang mirip dengan berikut ini:

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

Tindakan ini akan menampilkan respons seperti berikut:

{
      "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"
}

Mencantumkan tindakan keamanan

Untuk mencantumkan semua tindakan keamanan, masukkan perintah yang mirip dengan berikut ini:

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

Menjeda atau melanjutkan tindakan keamanan

Contoh berikut menunjukkan cara menjeda atau melanjutkan tindakan keamanan

Menjeda semua tindakan keamanan

Untuk Menjeda semua tindakan keamanan, masukkan perintah yang mirip dengan berikut ini:

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"}'

Tindakan ini akan menampilkan respons seperti berikut:

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

Melanjutkan tindakan keamanan yang dijeda

Untuk melanjutkan tindakan keamanan yang dijeda, masukkan perintah yang mirip dengan berikut:

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"}'

Tindakan ini akan menampilkan respons seperti berikut:

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

Menghapus tindakan keamanan

Untuk menghapus tindakan keamanan, masukkan perintah yang mirip dengan berikut ini:

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