Method: projects.tenants.accounts.delete

Deletes a user's account.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
targetProjectId

string

The ID of the project which the account belongs to. Should only be specified in authenticated requests that specify localId of an account.

Authorization requires the following IAM permission on the specified resource targetProjectId:

  • firebaseauth.users.delete
tenantId

string

The ID of the tenant that the account belongs to, if applicable. Only require to be specified for authenticated requests bearing a Google OAuth 2.0 credential that specify localId of an account that belongs to an Identity Platform tenant.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "localId": string,
  "delegatedProjectNumber": string,
  "idToken": string
}
Fields
localId

string

The ID of user account to delete. Specifying this field requires a Google OAuth 2.0 credential with proper permissions. Requests from users lacking the credential should pass an ID token instead.
delegatedProjectNumber
(deprecated)

string (int64 format)
idToken

string

The Identity Platform ID token of the account to delete. Require to be specified for requests from end users that lack Google OAuth 2.0 credential. Authenticated requests bearing a Google OAuth2 credential with proper permissions may pass localId to specify the account to delete alternatively.

Response body

If successful, the response body contains an instance of DeleteAccountResponse.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.