Try the new Conversation API Playground to learn more about using our API!

Method: agentUsers.delete

Unlinks an agent user from Google. As a result, all data related to this user will be deleted.

Here is how the agent user is created in Google:

  1. When a user opens their Google Home App, they can begin linking a 3p partner.
  2. User is guided through the OAuth process.
  3. After entering the 3p credentials, Google gets the 3p OAuth token and uses it to make a devices.sync call to the 3p partner and gets back all of the user's data, including agentUserId and devices.
  4. Google creates the agent user and stores a mapping from the agentUserId -> Google ID mapping. Google also stores all of the user's devices under that Google ID.

The mapping from agentUserId to Google ID is many to many, since one Google user can have multiple 3p accounts, and multiple Google users can map to one agentUserId (e.g., a husband and wife share one Nest account username/password).

The third-party user's identity is passed in as agentUserId. The agent is identified by the JWT signed by the partner's service account.

Note: Special characters (except "/") in agentUserId must be URL-encoded.

HTTP request

DELETE https://homegraph.googleapis.com/v1/{agentUserId=agentUsers/**}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
agentUserId

string

Required. Third-party user ID.

Query parameters

Parameters
requestId

string

Request ID used for debugging.

Request body

The request body must be empty.

Response body

If successful, the response body will be empty.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/homegraph

For more information, see the OAuth 2.0 Overview.