Method: projects.tenants.accounts.batchDelete

複数のアカウントを一括削除します。削除に失敗したアカウントの場合、レスポンスにはエラー情報が含まれます。このメソッドでは、リクエストに存在しないアカウントや重複するアカウントは無視されます。

このメソッドでは、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 をご覧ください。