Method: customers.devices.signDevice
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/devices/*}:signDevice
The URL uses gRPC Transcoding
syntax.
Path parameters
| Parameters |
device.name
|
string
Output only. The resource path name.
|
Request body
The request body contains data with the following structure:
| Fields |
device.fccId
|
string
The FCC identifier of the device.
|
device.serialNumber
|
string
A serial number assigned to the device by the device manufacturer.
|
device.preloadedConfig
|
object ( DeviceConfig
)
Configuration of the device, as specified via SAS Portal API.
|
device.activeConfig
|
object ( DeviceConfig
)
Output only. Current configuration of the device as registered to the SAS.
|
device.state
|
enum ( State
)
Output only. Device state.
|
device.grants[]
|
object ( DeviceGrant
)
Output only. Grants held by the device.
|
Response body
If successful, the response body will be empty.
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\u003eSigns a device with the provided FCC ID and serial number using the SAS Portal API.\u003c/p\u003e\n"],["\u003cp\u003eRequires a POST request to the specific endpoint \u003ccode\u003ehttps://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/devices/*}:signDevice\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes device details like FCC ID, serial number, preloaded and active configurations.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful signing, the response body will be empty.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the scope \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e.\u003c/p\u003e\n"]]],["This document details how to sign a device using a POST HTTP request to `https://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/devices/*}:signDevice`. The request requires a JSON body including the device's `fccId`, `serialNumber`, `preloadedConfig`, `activeConfig`, `state`, and `grants`. `device.name` is a path parameter indicating the resource path. A successful request returns an empty body. Authorization requires the `https://www.googleapis.com/auth/userinfo.email` OAuth scope.\n"],null,["# Method: customers.devices.signDevice\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 - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION.device.SCHEMA_REPRESENTATION)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION.device.SCHEMA_REPRESENTATION_1)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION.device.SCHEMA_REPRESENTATION_2)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nSigns a [device](/spectrum-access-system/reference/rest/customers.devices#Device).\n\n### HTTP request\n\n`POST https://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/devices/*}:signDevice`\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| `device.name` | `string` Output only. The resource path name. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"device\": { \"name\": string, \"fccId\": string, \"serialNumber\": string, \"preloadedConfig\": { object (/spectrum-access-system/reference/rest/customers.devices#Device.DeviceConfig) }, \"activeConfig\": { object (/spectrum-access-system/reference/rest/customers.devices#Device.DeviceConfig) }, \"state\": enum (/spectrum-access-system/reference/rest/customers.devices#Device.State_1), \"grants\": [ { object (/spectrum-access-system/reference/rest/customers.devices#Device.DeviceGrant) } ] } } ``` |\n\n| Fields ||\n|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `device.fccId` | `string` The FCC identifier of the device. |\n| `device.serialNumber` | `string` A serial number assigned to the device by the device manufacturer. |\n| `device.preloadedConfig` | `object (`[DeviceConfig](/spectrum-access-system/reference/rest/customers.devices#Device.DeviceConfig)`)` Configuration of the device, as specified via SAS Portal API. |\n| `device.activeConfig` | `object (`[DeviceConfig](/spectrum-access-system/reference/rest/customers.devices#Device.DeviceConfig)`)` Output only. Current configuration of the device as registered to the SAS. |\n| `device.state` | `enum (`[State](/spectrum-access-system/reference/rest/customers.devices#Device.State_1)`)` Output only. Device state. |\n| `device.grants[]` | `object (`[DeviceGrant](/spectrum-access-system/reference/rest/customers.devices#Device.DeviceGrant)`)` Output only. Grants held by the device. |\n\n### Response body\n\nIf successful, the response body will be empty.\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]
