Memulai

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Halaman ini menjelaskan cara memulai penggunaan Advanced API Security.

Peran yang diperlukan

Bagian berikut menjelaskan peran yang diperlukan untuk melakukan tugas menggunakan Advanced API Security.

Peran yang diperlukan untuk laporan keamanan

Tabel di bawah menunjukkan peran yang diperlukan untuk melakukan tugas yang terkait dengan laporan keamanan.

Tugas Laporan Keamanan	Peran yang Diperlukan
Mengaktifkan atau menonaktifkan Advanced API Security	Apigee Admin Organisasi (roles/apigee.admin)
Membuat dan melihat laporan	Apigee Admin Organisasi (roles/apigee.admin) Apigee Admin Keamanan (roles/apigee.securityAdmin)
Lihat laporan	Apigee Security Viewer (roles/apigee.securityViewer) Apigee Admin Keamanan (roles/apigee.securityAdmin)

Peran yang diperlukan untuk penilaian risiko

Tabel di bawah menunjukkan peran yang diperlukan untuk melakukan tugas yang terkait dengan penilaian risiko.

Tugas Penilaian Risiko	Peran yang Diperlukan
Membuat, memperbarui, atau menghapus profil keamanan khusus	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Admin Organisasi (roles/apigee.admin)
Memasang atau melepaskan profil keamanan	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Admin Organisasi (roles/apigee.admin)
Lihat skor keamanan	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Admin Organisasi (roles/apigee.admin)
Tampilkan daftar semua profil keamanan atau dapatkan profil	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Admin Organisasi (roles/apigee.admin)

Peran yang diperlukan untuk mendeteksi penyalahgunaan

Tabel di bawah menunjukkan peran yang diperlukan untuk melakukan tugas yang terkait dengan deteksi penyalahgunaan.

Tugas Deteksi Penyalahgunaan	Peran yang Diperlukan
Melihat insiden di UI Deteksi penyalahgunaan	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Admin Organisasi (roles/apigee.admin)

Peran yang diperlukan untuk tindakan keamanan

Tabel di bawah menunjukkan peran yang diperlukan untuk melakukan tugas yang terkait dengan tindakan keamanan.

Tugas Tindakan Keamanan	Peran yang Diperlukan
Membuat tindakan keamanan	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Admin Organisasi (roles/apigee.admin)
Perbarui konfigurasi tindakan keamanan	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Admin Organisasi (roles/apigee.admin)
Melihat atau mencantumkan tindakan keamanan	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Admin Organisasi (roles/apigee.admin)
Memeriksa status penegakan kebijakan	Apigee Admin Keamanan (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Admin Organisasi (roles/apigee.admin)

Catatan: Untuk melakukan panggilan API yang dijelaskan di bagian berikut, Anda harus dapatkan OAuth 2.0 token akses, yang diteruskan dengan panggilan.

Mengelola Keamanan API Lanjutan untuk organisasi Langganan

Untuk menggunakan Advanced API Security sebagai pelanggan Langganan, Anda harus mengaktifkannya di organisasi, sebagaimana dijelaskan dalam bagian berikut:

• Mendapatkan konfigurasi add-on Apigee
• Mengaktifkan Advanced API Security for Subscription organisasi

Jika tidak yakin apakah Anda menggunakan Apigee Langganan atau Bayar sesuai penggunaan organisasi, hubungi administrator organisasi Apigee Anda.

Mendapatkan konfigurasi add-on Apigee

Untuk mengaktifkan Advanced API Security untuk organisasi Langganan Anda, Anda harus terlebih dahulu untuk mendapatkan konfigurasi add-on Apigee saat ini, menggunakan panggilan API berikut. Pesan ini juga akan memberitahukan apakah Advanced API Security sudah diaktifkan.

curl "https://apigee.googleapis.com/v1/organizations/ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

di mana

• ORG adalah nama organisasi Anda.
• $TOKEN adalah variabel lingkungan untuk Token akses OAuth.

Panggilan ini menampilkan informasi dasar tentang organisasi Anda, termasuk bagian untuk konfigurasi add-on Apigee yang dimulai dengan baris:

"addonsConfig": {

Periksa apakah bagian ini berisi entri berikut:

"apiSecurityConfig": {
          "enabled": true
      }

Jika demikian, Advanced API Security sudah diaktifkan di organisasi. Jika tidak, Anda harus mengaktifkannya, seperti yang dijelaskan selanjutnya.

Mengaktifkan Advanced API Security for Subscription organisasi

Untuk mengaktifkan Advanced API Security dalam organisasi Subscription dengan konfigurasi default, berikan Permintaan POST seperti yang ditunjukkan di bawah ini.

Perhatian: Panggilan API ini akan menimpa konfigurasi add-on saat ini. Anda harus menyertakan konfigurasi saat ini untuk semua add-on dalam permintaan yang ditampilkan di bawah agar tidak ditimpa.

Catatan:

• Jika Anda membuat lingkungan baru setelah mengaktifkan Advanced API Security, Anda harus menjalankan kembali perintah di bawah ini untuk mengaktifkan Advanced API Security untuk lingkungan baru. Perhatikan bahwa tidak perlu menonaktifkan Advanced API Security sebelum menjalankan perintah tersebut kembali.
• Jika Anda cukup melepaskan lingkungan tempat Advanced API Security diaktifkan dari instance, lalu melampirkannya kembali. Anda tidak perlu menjalankan perintah di bawah ini lagi.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      }
      <Other entries of your current add-ons configuration>
    }
  }'

di mana

• ORG adalah nama organisasi Anda.
• $TOKEN adalah variabel lingkungan untuk Token akses OAuth.
• <Other entries of your current add-ons configuration> terdiri dari entri lain dari Konfigurasi add-on Apigee.

Catatan: Panggilan API di atas memulai operasi yang berjalan lama yang mungkin perlu waktu agak lama untuk menyelesaikannya.

Misalnya, jika konfigurasi add-on saat ini sesuai dengan

"addonsConfig": {
  "integrationConfig": {
      "enabled":true
  },
  "monetizationConfig": {
      "enabled":true
  }
},

perintah untuk mengaktifkan Advanced API Security adalah

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      },
      "integrationConfig": {
          "enabled": true
      },
      "monetizationConfig": {
          "enabled": true
      }
    }
  }'

Setelah mengirim permintaan, Anda akan melihat respons seperti berikut:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

Catatan: Saat Anda mengaktifkan Advanced API Security di organisasi, mungkin perlu waktu hingga satu hari agar skor untuk proxy dan target yang ada tercermin dalam suatu lingkungan.

Nonaktifkan Advanced API Security for Subscription organisasi

Jika karena alasan tertentu Anda perlu menonaktifkan Advanced API Security di organisasi Subscription, Anda dapat melakukannya dengan mengeluarkan permintaan POST, dengan meneruskan add-on dalam isi permintaan Anda, seperti yang ditunjukkan di bawah ini.

Perhatian: Konfigurasi add-on yang Anda teruskan dalam isi permintaan akan menimpa konfigurasi add-on saat ini. Lihat konfigurasi add-on saat ini di profil organisasi Apigee dan pastikan untuk memasukkannya dalam {i>payload<i} permintaan.

Catatan: Panggilan API di bawah ini memulai operasi yang berjalan lama yang mungkin perlu waktu agak lama untuk menyelesaikannya.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": false
      }
     <Include current add-ons configuration>
    }
  }'

Berikut ini contoh respons yang menunjukkan bahwa operasi sedang berlangsung:

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Untuk mengetahui informasi selengkapnya, lihat Mengonfigurasi add-on API organisasi.

Kelola Advanced API Security untuk organisasi Bayar sesuai penggunaan

Jika Anda adalah pelanggan Pay-as-you-go, Anda dapat mengaktifkan Advanced API Security sebagai add-on berbayar. Untuk informasi selengkapnya tentang mengaktifkan add-on Advanced API Security untuk Apigee Menengah atau Komprehensif lingkungan, lihat Kelola add-on Advanced API Security.

Jika tidak yakin apakah Anda menggunakan Apigee Langganan atau Bayar sesuai penggunaan organisasi, hubungi administrator organisasi Apigee Anda.

Langkah berikutnya

Setelah mengaktifkan Advanced API Security, lihat bagian berikut:

• Laporan keamanan
• Penilaian risiko
• Deteksi penyalahgunaan
• Tindakan keamanan