Memulai

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Halaman ini menjelaskan cara memulai penggunaan Advanced API Security untuk organisasi langganan dan bayar sesuai penggunaan.

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	Apigee Organization Admin (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 kustom	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)
Melihat skor keamanan	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)
Mencantumkan semua profil keamanan atau mendapatkan profil	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)

Peran yang diperlukan untuk deteksi 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 Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (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 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) Apigee Organization Admin (roles/apigee.admin)
Memeriksa status penegakan	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)

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

Mengelola Keamanan API Lanjutan untuk organisasi Langganan

Untuk menggunakan Advanced API Security sebagai pelanggan Langganan, Advanced API Security harus menjadi bagian dari hak Langganan Anda. Lihat Hak Apigee. Untuk menambahkan Advanced API Security ke hak Anda, hubungi Penjualan Apigee.

Catatan: Organisasi uji coba Apigee dapat menyertakan uji coba Advanced API Security Apigee selama periode uji coba. Hubungi Penjualan Apigee di Apigee untuk mendapatkan informasi.

Setelah Keamanan API Lanjutan menjadi bagian dari hak Anda, aktifkan di organisasi Anda:

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

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

Mendapatkan konfigurasi add-on Apigee

Untuk mengaktifkan Advanced API Security bagi organisasi Langganan, 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 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, Keamanan API Lanjutan sudah diaktifkan di organisasi. Jika tidak, Anda harus mengaktifkannya, seperti yang dijelaskan berikutnya.

Mengaktifkan Keamanan API Lanjutan untuk organisasi Langganan

Untuk mengaktifkan Advanced API Security di organisasi Langganan dengan konfigurasi default, berikan permintaan POST seperti yang ditunjukkan di bawah.

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 untuk mencegahnya ditimpa.

Catatan:

• Jika membuat lingkungan baru setelah mengaktifkan Advanced API Security, Anda harus menjalankan perintah di bawah lagi untuk 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, Anda tidak perlu menjalankan perintah di bawah 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 saat ini.

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

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

Menonaktifkan Advanced API Security untuk organisasi Langganan

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

Perhatian: Konfigurasi add-on yang Anda teruskan dalam isi permintaan akan mengganti 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 memulai operasi yang berjalan lama yang mungkin memerlukan waktu untuk diselesaikan.

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 Lanjutan untuk organisasi Bayar sesuai penggunaan

Jika Anda adalah pelanggan Pay-as-you-go, Anda dapat mengaktifkan Keamanan API Lanjutan 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 Anda tidak yakin apakah menggunakan organisasi Apigee Langganan atau Bayar sesuai penggunaan, hubungi administrator organisasi Apigee Anda.

Langkah berikutnya

Setelah mengaktifkan Keamanan API Lanjutan, lihat bagian berikut:

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