Method: deployments.devices.updateSigned

  • This operation updates a signed device using a PATCH request to a specific endpoint.

  • The request body must contain the encoded device as a JSON Web Token and the installer ID.

  • A successful response returns the updated device information.

  • Authorization requires the https://www.googleapis.com/auth/sasportal scope.

Updates a signed device.

HTTP request

PATCH https://sasportal.googleapis.com/v1alpha1/{name=deployments/*/devices/*}:updateSigned

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the device to update.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "encodedDevice": string,
  "installerId": string
}
Fields
encodedDevice

string (bytes format)

Required. The JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The userId field must be set.

A base64-encoded string.
installerId

string

Required. Unique installer ID (CPI ID) from the Certified Professional Installers database.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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