Method: projects.tenants.accounts.delete

Exclui a conta de um usuário.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
targetProjectId

string

O ID do projeto ao qual a conta pertence. Só pode ser especificado em solicitações autenticadas que especificam o localId de uma conta.

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

  • firebaseauth.users.delete
tenantId

string

O ID do locatário a que a conta pertence, se aplicável. Só é necessário especificar para solicitações autenticadas com uma credencial do Google OAuth 2.0 que especifique o localId de uma conta que pertence a um locatário da Identity Platform.

Corpo da solicitação

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

Representação JSON 
{
  "localId": string,
  "delegatedProjectNumber": string,
  "idToken": string
}
Campos
localId

string

O ID da conta de usuário a ser excluída. Para especificar esse campo, é necessário ter uma credencial do Google OAuth 2.0 com as permissões adequadas. As solicitações de usuários sem a credencial precisam transmitir um token de ID.
delegatedProjectNumber
(deprecated)

string (int64 format)
idToken

string

O token de ID do Identity Platform da conta a ser excluída. Exige que seja especificado para solicitações de usuários finais que não têm a credencial do Google OAuth 2.0. As solicitações autenticadas com uma credencial do Google OAuth2 e as permissões adequadas podem transmitir o localId para especificar a conta a ser excluída.

Corpo da resposta

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.