Method: customers.devices.updateSigned
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
PATCH https://sasportal.googleapis.com/v1alpha1/{name=customers/*/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. 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/userinfo.email
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThis documentation outlines the process for updating a signed device using a \u003ccode\u003ePATCH\u003c/code\u003e request to the specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires path and body parameters, including device name, encoded device data, and installer ID.\u003c/p\u003e\n"],["\u003cp\u003eIf successful, the response returns the updated device information.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details updating a signed device via a PATCH request to `https://sasportal.googleapis.com/v1alpha1/{name=customers/*/devices/*}:updateSigned`. The request requires a `name` path parameter identifying the device. The request body, in JSON, includes `encodedDevice`, a base64-encoded, signed JSON Web Token representing the device, and `installerId`, a unique CPI ID. A successful response returns an instance of the updated `Device`. Authorization requires the `https://www.googleapis.com/auth/userinfo.email` OAuth scope.\n"],null,["# Method: customers.devices.updateSigned\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nUpdates a signed [device](/spectrum-access-system/reference/rest/customers.devices#Device).\n\n### HTTP request\n\n`PATCH https://sasportal.googleapis.com/v1alpha1/{name=customers/*/devices/*}:updateSigned`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------|\n| `name` | `string` Required. The name of the device to update. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|------------------------------------------------------------|---|\n| ``` { \"encodedDevice\": string, \"installerId\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `encodedDevice` | `string (`[bytes](/discovery/v1/type-format)` format)` Required. The JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the [device](/spectrum-access-system/reference/rest/customers.devices#Device). A base64-encoded string. \u003cbr /\u003e |\n| `installerId` | `string` Required. Unique installer ID (CPI ID) from the Certified Professional Installers database. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Device](/spectrum-access-system/reference/rest/customers.devices#Device).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]