Method: projects.tenants.accounts.batchDelete

Menghapus beberapa akun secara massal. Untuk akun yang gagal dihapus, info error akan disertakan dalam respons. Metode ini mengabaikan akun yang tidak ada atau diduplikasi dalam permintaan.

Metode ini memerlukan kredensial Google OAuth 2.0 dengan izin yang sesuai.

Permintaan HTTP

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
targetProjectId

string

Jika tenantId ditentukan, ID project Google Cloud tempat tenant Identity Platform berada. Jika tidak, ID project Google Cloud yang menjadi milik akun.

Otorisasi memerlukan izin IAM berikut pada resource targetProjectId yang ditentukan:

  • firebaseauth.users.delete
tenantId

string

Jika akun tersebut milik tenant Identity Platform, ID tenant. Jika akun termasuk dalam project Identity Platform default, kolom ini tidak diperlukan.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "localIds": [
    string
  ],
  "force": boolean
}
Kolom
localIds[]

string

Wajib. Daftar ID pengguna yang akan dihapus.
force

boolean

Apakah akan memaksa penghapusan akun yang tidak dalam status dinonaktifkan. Jika salah, hanya akun yang dinonaktifkan yang akan dihapus, dan akun yang tidak dinonaktifkan akan ditambahkan ke errors.

Isi respons

Jika berhasil, isi respons akan berisi instance BatchDeleteAccountsResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.