Method: projects.accounts.batchDelete

批量删除多个账号。对于无法删除的账号，响应中会包含错误信息。该方法会忽略请求中不存在或重复的账号。

此方法需要具有适当权限的 Google OAuth 2.0 凭据。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
targetProjectId

string

如果指定了 tenantId，则为 Identity Platform 租户所属的 Google Cloud 项目的 ID。否则，请使用账号所属的 Google Cloud 项目的 ID。

必须对指定的资源 targetProjectId 具有以下 IAM 权限才能进行授权：

  • firebaseauth.users.delete

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "localIds": [
    string
  ],
  "force": boolean,
  "tenantId": string
}
字段
localIds[]

string

必需。要删除的用户 ID 的列表。
force

boolean

是否强制删除非停用状态的账号。如果为 false，则仅会删除已停用的账号，未停用的账号会添加到 errors。
tenantId

string

如果账号属于 Identity Platform 租户，请提供租户的 ID。如果账号属于默认的 Identity Platform 项目，则无需填写此字段。

响应正文

如果成功，则响应正文包含一个 BatchDeleteAccountsResponse 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。