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
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.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-03-04 UTC."],[[["\u003cp\u003eThis API method facilitates the batch deletion of multiple user accounts, ignoring non-existent or duplicate accounts specified in the request.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful deletions return a response body, while errors for specific accounts are included in the same response; only disabled accounts will be deleted unless the \u003ccode\u003eforce\u003c/code\u003e field is \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe method uses a POST request to a specific URL, which includes parameters for \u003ccode\u003etargetProjectId\u003c/code\u003e and \u003ccode\u003etenantId\u003c/code\u003e, with \u003ccode\u003etargetProjectId\u003c/code\u003e being the ID of the project the accounts belong to and \u003ccode\u003etenantId\u003c/code\u003e the ID of the tenant, if applicable.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be in JSON format, including a list of user IDs (\u003ccode\u003elocalIds\u003c/code\u003e) to be deleted and an optional boolean \u003ccode\u003eforce\u003c/code\u003e field that will determine if it will delete non-disabled accounts.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization is required, using a Google OAuth 2.0 credential with specified IAM permissions and one of three listed OAuth scopes.\u003c/p\u003e\n"]]],[],null,["# Method: projects.tenants.accounts.batchDelete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nBatch deletes multiple accounts. For accounts that fail to be deleted, error info is contained in the response. The method ignores accounts that do not exist or are duplicated in the request.\n\nThis method requires a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).\n\n### HTTP request\n\n`POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts:batchDelete`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [BatchDeleteAccountsResponse](/identity-platform/docs/reference/rest/v1/BatchDeleteAccountsResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/identitytoolkit`\n- `\n https://www.googleapis.com/auth/firebase`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
