Method: customers.deployments.devices.createSigned

  • Creates a signed device under a node or customer using an HTTP POST request.

  • Requires a JSON Web Token in the request body signed with a CPI private key containing device details.

  • The request must include a unique installer ID from the Certified Professional Installers database.

  • Upon successful creation, the response returns the details of the newly created device.

  • Requires authorization with the https://www.googleapis.com/auth/sasportal scope.

Creates a signed device under a node or customer.

HTTP request

POST https://sasportal.googleapis.com/v1alpha1/{parent=customers/*/deployments/*}/devices:createSigned

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent resource.

Request body

The request body contains data with the following structure:

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

string (bytes format)

Required. 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