Memulai

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Halaman ini menjelaskan cara mulai menggunakan 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 terkait laporan keamanan.

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

Peran yang diperlukan untuk penilaian risiko

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

Tugas Penilaian Risiko	Peran yang Diperlukan
Membuat, memperbarui, atau menghapus profil keamanan khusus	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin)
Melampirkan atau melepaskan profil keamanan	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin)
Lihat skor keamanan	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Admin Organisasi Apigee (roles/apigee.admin)
Mencantumkan semua profil keamanan atau mendapatkan profil	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Admin Organisasi Apigee (roles/apigee.admin)

Peran yang diperlukan untuk deteksi penyalahgunaan

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

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

Peran yang diperlukan untuk tindakan keamanan

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

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

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

Mengelola Keamanan API Tingkat Lanjut untuk organisasi Langganan

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

• Mendapatkan konfigurasi add-on Apigee
• Mengaktifkan Advanced API Security untuk organisasi Langganan

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

Mendapatkan konfigurasi add-on Apigee

Guna mengaktifkan Advanced API Security untuk organisasi Langganan Anda, Anda harus mendapatkan konfigurasi add-on Apigee saat ini terlebih dahulu, menggunakan panggilan API berikut. Tindakan ini juga akan memberi tahu Anda apakah Advanced API Security telah diaktifkan.

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

dengan

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

Panggilan ini akan 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 telah diaktifkan di organisasi. Jika tidak, Anda perlu mengaktifkannya, seperti yang dijelaskan berikutnya.

Mengaktifkan Keamanan API Lanjutan untuk organisasi Langganan

Untuk mengaktifkan Advanced API Security dalam organisasi Langganan 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 perintah di bawah ini lagi guna mengaktifkan Advanced API Security untuk lingkungan baru. Perhatikan bahwa Anda tidak perlu menonaktifkan Advanced API Security sebelum menjalankan perintah lagi.
• Jika Anda hanya melepaskan lingkungan tempat Advanced API Security diaktifkan dari instance, lalu memasangnya kembali di lain waktu, 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>
    }
  }'

dengan

• 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 Anda saat ini.

Catatan: Panggilan API di atas akan memulai operasi yang berjalan lama yang mungkin memerlukan waktu beberapa saat untuk menyelesaikannya.

Misalnya, jika konfigurasi add-on saat ini adalah

"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: Jika Anda mengaktifkan Advanced API Security dalam organisasi, perlu waktu hingga satu hari agar skor untuk proxy dan target yang ada ditampilkan dalam lingkungan.

Nonaktifkan Keamanan API Lanjutan untuk organisasi Langganan

Jika karena alasan tertentu Anda perlu menonaktifkan Advanced API Security di organisasi Subscription, Anda dapat melakukannya dengan mengajukan permintaan POST, dengan meneruskan konfigurasi add-on dalam isi permintaan, 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 menyertakannya dalam payload permintaan.

Catatan: Panggilan API di bawah akan memulai operasi yang berjalan lama yang mungkin memerlukan waktu beberapa saat 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 adalah 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 informasi selengkapnya, lihat Mengonfigurasi API add-on organisasi.

Mengelola Keamanan API Tingkat Lanjut 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 cara mengaktifkan add-on Advanced API Security untuk lingkungan Apigee Menengah atau Komprehensif, lihat Mengelola add-on Advanced API Security.

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

Langkah berikutnya

Setelah Anda mengaktifkan Advanced API Security, lihat bagian berikut:

• Laporan keamanan
• Penilaian risiko
• Mendeteksi penyalahgunaan
• Tindakan keamanan