Method: projects.tenants.accounts.batchDelete

Exclui várias contas em lote. Para contas que não podem ser excluídas, as informações de erro estão na resposta. O método ignora contas que não existem ou são duplicadas na solicitação.

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

Solicitação HTTP

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

O URL usa a 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 da Identity Platform pertence. Caso contrário, o ID do projeto do Google Cloud a que 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 pertencem a um projeto padrão do Identity Platform, o campo não é necessário.

Corpo da solicitação

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ários a serem excluídos.
force

boolean

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de BatchDeleteAccountsResponse.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.