Method: customers.nodes.devices.createSigned
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/{parent=customers/*/nodes/*}/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
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 API creates a signed device under a node or customer within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires an HTTP POST to a specific URL with path parameters specifying the parent resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain a JSON Web Token representing the encoded device and a unique installer ID.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful execution, the response returns details about the created device.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This content outlines the process of creating a signed device under a node or customer via an HTTP POST request. The request is sent to a specific URL, utilizing gRPC Transcoding syntax. The required path parameter is `parent`, indicating the parent resource name. The request body, in JSON format, contains an `encodedDevice` (a JWT-signed device) and an `installerId` (CPI ID). Successful requests return a `Device` instance. This action requires the `sasportal` OAuth scope for authorization.\n"],null,["# Method: customers.nodes.devices.createSigned\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\nCreates a signed [device](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device) under a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer).\n\n### HTTP request\n\n`POST https://sasportal.googleapis.com/v1alpha1/{parent=customers/*/nodes/*}/devices:createSigned`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------|\n| `parent` | `string` Required. The name of the parent resource. |\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. 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`"]]