Method: customers.devices.updateSigned
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Requête HTTP
PATCH https://sasportal.googleapis.com/v1alpha1/{name=customers/*/devices/*}:updateSigned
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres |
name |
string
Obligatoire. Nom de l'appareil à mettre à jour.
|
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
{
"encodedDevice": string,
"installerId": string
} |
Champs |
encodedDevice |
string (bytes format)
Obligatoire. Jeton Web JSON signé à l'aide d'une clé privée CPI. La charge utile doit être l'encodage JSON de device . Le champ userId doit être défini. Chaîne encodée en base64.
|
installerId |
string
Obligatoire. ID unique de l'installateur (ID CPI) provenant de la base de données des installateurs professionnels certifiés.
|
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de Device
.
Champs d'application des autorisations
Requiert le champ d'application OAuth suivant :
https://www.googleapis.com/auth/sasportal
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eThis API updates a signed device in the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eThe request must include an encoded device and installer ID.\u003c/p\u003e\n"],["\u003cp\u003eThe device payload must be JSON Web Token signed with a CPI private key and contain the userId field.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details the process of updating a signed device via a PATCH request to the specified URL: `https://sasportal.googleapis.com/v1alpha1/{name=customers/*/devices/*}:updateSigned`. The `name` path parameter is required, representing the device's name. The request body must include a JSON object containing the `encodedDevice` (a base64-encoded JSON Web Token of the device) and the `installerId` (CPI ID). Successful requests return a Device instance and requires the `https://www.googleapis.com/auth/sasportal` 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/v1alpha1/customers.deployments.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://google.aip.dev/127) 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](https://developers.google.com/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/v1alpha1/customers.deployments.devices#Device). The [userId](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device.DeviceConfig.FIELDS.user_id) field must be set. A base64-encoded string. |\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/v1alpha1/customers.deployments.devices#Device).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]