Method: devices.requestSync

Requests a SYNC call from Google to a 3p partner's home control agent for a user.

The third-party user's identity is passed in as agentUserId (see RequestSyncDevicesRequest) and forwarded back to the agent. The agent is identified by the API key or JWT signed by the partner's service account.

HTTP request

POST https://homegraph.googleapis.com/v1/devices:requestSync

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "agentUserId": string,
  "async": boolean
}
Fields
agentUserId

string

Required. Third-party user ID issued by agent's third-party identity provider.

async

boolean

Optional. If set, the request will be added to a queue and a response will be returned immediately. The queue allows for de-duplication of simultaneous requests.

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.