Firebase Rules API

Membuat dan mengelola aturan yang menentukan kapan layanan yang mendukung Aturan Keamanan Firebase harus mengizinkan permintaan.

• Sumber Daya REST: v1.projects
• Sumber Daya REST: v1.projects.releases
• Sumber Daya REST: v1.projects.rulesets

Dokumentasi referensi ini berlaku untuk mengelola Aturan Keamanan Firebase untuk Cloud Firestore dan Cloud Storage untuk Firebase. Untuk informasi tentang pengelolaan Aturan Keamanan Firebase Realtime Database, lihat Mengelola Aturan Firebase Realtime Database menggunakan REST .

Untuk deskripsi alat yang dapat Anda gunakan untuk mengelola Aturan Keamanan, termasuk REST API ini, lihat Mengelola dan menerapkan Aturan Keamanan Firebase .

Anda dapat mencoba memanggil metode REST API Aturan Keamanan pada data langsung menggunakan API Explorer yang tertanam. API Explorer ini memungkinkan Anda melihat permintaan dan respons API tanpa meninggalkan dokumentasi referensi API.

Temukan penjelajah tersemat di panel samping halaman referensi setiap metode (klik metode mana pun pada tabel di bawah).

Ringkasan

Aturan Keamanan Firebase terdiri dari bahasa dan API. Pengembang menulis aturan dalam bahasa tersebut, memublikasikannya melalui API, lalu mengirimkan permintaan ke layanan yang mendukung Aturan Keamanan Firebase. Layanan mengevaluasi permintaan menggunakan aturan yang disediakan dan menentukan apakah permintaan tersebut harus diizinkan.

Istilah berikut digunakan dalam dokumentasi referensi ini.

• Source : Bahasa khusus domain yang berisi aturan yang mencakup service dan path yang menjelaskan kondisi ketika operation request tertentu diizinkan.

• Ruleset : Salinan konten Source yang tidak dapat diubah dan tetap dengan nama yang dihasilkan.

• Release : Nama referensi untuk Ruleset , yang membuat Ruleset tersedia untuk digunakan dan diterapkan oleh layanan yang mendukung Aturan Keamanan Firebase.

Layanan: firebaserules.googleapis.com

Untuk memanggil layanan ini, kami menyarankan Anda menggunakan perpustakaan klien yang disediakan Google. Jika aplikasi Anda perlu menggunakan perpustakaan Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat Anda membuat permintaan API.

Dokumen penemuan

Dokumen Penemuan adalah spesifikasi yang dapat dibaca mesin untuk mendeskripsikan dan menggunakan REST API. Ini digunakan untuk membangun perpustakaan klien, plugin IDE, dan alat lain yang berinteraksi dengan Google API. Satu layanan mungkin menyediakan beberapa dokumen penemuan. Layanan ini menyediakan dokumen penemuan berikut:

• https://firebaserules.googleapis.com/$discovery/rest?version=v1

Titik akhir layanan

Titik akhir layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan mungkin memiliki beberapa titik akhir layanan. Layanan ini memiliki titik akhir layanan berikut dan semua URI di bawah ini bersifat relatif terhadap titik akhir layanan ini:

• https://firebaserules.googleapis.com

Sumber Daya REST: v1.projects

Metode
test	POST /v1/{name=projects/**}:test Source Uji untuk kebenaran sintaksis dan semantik.

Sumber Daya REST: v1.projects.releases

Metode
create	POST /v1/{name=projects/*}/releases Buat Release .
delete	DELETE /v1/{name=projects/*/releases/**} Hapus Release berdasarkan nama sumber daya.
get	GET /v1/{name=projects/*/releases/**} Dapatkan Release berdasarkan nama.
getExecutable	GET /v1/{name=projects/*/releases/**}:getExecutable Dapatkan Release yang dapat dieksekusi untuk digunakan saat menegakkan aturan.
list	GET /v1/{name=projects/*}/releases Cantumkan nilai Release untuk sebuah proyek.
patch	PATCH /v1/{name=projects/*/releases/**} Perbarui Release melalui PATCH.

Sumber Daya REST: v1.projects.rulesets

Metode
create	POST /v1/{name=projects/*}/rulesets Buat Ruleset dari Source .
delete	DELETE /v1/{name=projects/*/rulesets/*} Hapus Ruleset berdasarkan nama sumber daya.
get	GET /v1/{name=projects/*/rulesets/*} Dapatkan Ruleset berdasarkan nama termasuk konten Source lengkap.
list	GET /v1/{name=projects/*}/rulesets Cantumkan metadata Ruleset saja dan filter hasilnya secara opsional berdasarkan nama Ruleset .