Method: projects.accounts.batchDelete

Mehrere Konten werden gleichzeitig gelöscht. Bei Konten, die nicht gelöscht werden können, enthält die Antwort Fehlerinformationen. Konten, die nicht vorhanden sind oder in der Anfrage dupliziert sind, werden von der Methode ignoriert.

Für diese Methode sind Google OAuth 2.0-Anmeldedaten mit den entsprechenden Berechtigungen erforderlich.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
targetProjectId

string

Wenn tenantId angegeben ist, die ID des Google Cloud-Projekts, zu dem der Identity Platform-Tenant gehört. Andernfalls die ID des Google Cloud-Projekts, zu dem die Konten gehören.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource targetProjectId erforderlich:

  • firebaseauth.users.delete

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "localIds": [
    string
  ],
  "force": boolean,
  "tenantId": string
}
Felder
localIds[]

string

Pflichtangabe. Liste der zu löschenden Nutzer-IDs.
force

boolean

Ob Konten, die nicht deaktiviert sind, erzwungen gelöscht werden sollen. Wenn „false“ (falsch) festgelegt ist, werden nur deaktivierte Konten gelöscht und nicht deaktivierte Konten werden der errors hinzugefügt.
tenantId

string

Wenn die Konten zu einem Identity Platform-Mandanten gehören, die ID des Mandanten. Wenn die Konten zu einem Standard-Identity Platform-Projekt gehören, ist das Feld nicht erforderlich.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von BatchDeleteAccountsResponse.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.