Method: projects.tenants.accounts.batchDelete

O lote exclui várias contas. Para contas que não foram excluídas, as informações do erro estão contidas na resposta. O método ignora contas que não existem ou estão duplicadas na solicitação.

Este método requer uma credencial Google OAuth 2.0 com as permissões adequadas.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
targetProjectId

string

Se tenantId for especificado, o ID do projeto do Google Cloud ao qual o locatário do Identity Platform pertence. Caso contrário, o ID do projeto do Google Cloud ao qual as contas pertencem.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId :

  • firebaseauth.users.delete
tenantId

string

Se as contas pertencerem a um locatário do Identity Platform, o ID do locatário. Se as contas pertencerem a um projeto padrão do Identity Platform, o campo não será necessário.

Solicitar corpo

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "localIds": [
    string
  ],
  "force": boolean
}
Campos
localIds[]

string

Obrigatório. Lista de IDs de usuário a serem excluídos.

force

boolean

Se deve forçar a exclusão de contas que não estão no estado desativado. Se for falso, apenas as contas desativadas serão excluídas e as contas que não estiverem desativadas serão adicionadas aos errors .

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de BatchDeleteAccountsResponse .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte oAuthentication Overview .