Method: customers.devices.createSigned
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/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:
Fields |
encodedDevice
|
string ( bytes
format)
Required. 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 (cpiId) 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eCreates a signed device under a node or customer using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eRequires a JSON Web Token signed with a CPI private key and a unique installer ID in the request body.\u003c/p\u003e\n"],["\u003cp\u003eReturns the created device details upon successful completion.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This documentation details how to create a signed device under a node or customer. A `POST` request is sent to a specific URL, including a required `parent` path parameter. The request body must contain a `encodedDevice` string (a JWT signed with a CPI private key) and a `installerId` string. The successful response will include a `Device` instance. This operation requires OAuth scope: `https://www.googleapis.com/auth/userinfo.email`.\n"],null,["# Method: customers.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/customers.devices#Device) under a [node](/spectrum-access-system/reference/rest/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/customers#Customer).\n\n### HTTP request\n\n`POST https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/devices:createSigned`\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| `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](/discovery/v1/type-format)` format)` Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the \\[Device\\]. A base64-encoded string. \u003cbr /\u003e |\n| `installerId` | `string` Required. Unique installer id (cpiId) 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`"]]