Method: projects.tenants.accounts.batchDelete

批次刪除多個帳戶。如果無法刪除帳戶,回應中就會包含錯誤資訊。這個方法會忽略不存在或在要求中重複的帳戶。

這個方法需要具備適當權限的 Google OAuth 2.0 憑證。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
targetProjectId

string

如果指定 tenantId,則為 Identity Platform 租用戶所屬 Google Cloud 專案的 ID。否則,則為帳戶所屬 Google Cloud 專案的 ID。

授權需要指定資源 targetProjectId 的下列 IAM 權限:

  • firebaseauth.users.delete
tenantId

string

如果帳戶屬於 Identity Platform 租戶,則為租戶的 ID。如果帳戶屬於預設 Identity Platform 專案,則不需要這個欄位。

要求主體

要求主體包含下列結構的資料:

JSON 表示法
{
  "localIds": [
    string
  ],
  "force": boolean
}
欄位
localIds[]

string

這是必要旗標,要刪除的使用者 ID 清單。

force

boolean

是否強制刪除未停用的帳戶。如果為 false,系統只會刪除已停用的帳戶,並將未停用的帳戶新增至 errors

回應主體

如果成功,回應主體會包含 BatchDeleteAccountsResponse 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱 Authentication Overview