AI-generated Key Takeaways
-
This API creates a signed device under a node or customer within the Spectrum Access System.
-
The request requires an HTTP POST to a specific URL with path parameters specifying the parent resource.
-
The request body must contain a JSON Web Token representing the encoded device and a unique installer ID.
-
Upon successful execution, the response returns details about the created device.
-
Authorization requires the
https://www.googleapis.com/auth/sasportal
scope.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/{parent=customers/*/nodes/*}/devices:createSigned
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
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 |
Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the A base64-encoded string. |
installerId |
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