Method: nodes.devices.signDevice
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/{device.name=nodes/*/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:
JSON representation |
{
"device": {
"name": string,
"fccId": string,
"serialNumber": string,
"preloadedConfig": {
"category": enum (DeviceCategory ),
"model": {
object (DeviceModel )
},
"airInterface": {
object (DeviceAirInterface )
},
"installationParams": {
object (InstallationParams )
},
"measurementCapabilities": [
enum (MeasurementCapability )
],
"userId": string,
"callSign": string,
"state": enum (State ),
"isSigned": boolean,
"updateTime": string
},
"activeConfig": {
"category": enum (DeviceCategory ),
"model": {
object (DeviceModel )
},
"airInterface": {
object (DeviceAirInterface )
},
"installationParams": {
object (InstallationParams )
},
"measurementCapabilities": [
enum (MeasurementCapability )
],
"userId": string,
"callSign": string,
"state": enum (State ),
"isSigned": boolean,
"updateTime": string
},
"state": enum (State ),
"grants": [
{
"maxEirp": number,
"frequencyRange": {
object (FrequencyRange )
},
"state": enum (GrantState ),
"channelType": enum (ChannelType ),
"moveList": [
{
object (DpaMoveList )
}
],
"expireTime": string,
"suspensionReason": [
string
],
"grantId": string,
"lastHeartbeatTransmitExpireTime": string
}
],
"displayName": string,
"deviceMetadata": {
"interferenceCoordinationGroup": string,
"commonChannelGroup": string,
"antennaModel": string,
"nrqzValidated": boolean,
"nrqzValidation": {
object (NrqzValidation )
}
},
"currentChannels": [
{
"frequencyRange": {
object (FrequencyRange )
},
"score": number
}
],
"grantRangeAllowlists": [
{
"lowFrequencyMhz": number,
"highFrequencyMhz": number
}
]
}
} |
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.
|
device.displayName |
string
Device display name.
|
device.deviceMetadata |
object (DeviceMetadata )
Device parameters that can be overridden by both SAS Portal and SAS registration requests.
|
device.currentChannels[] (deprecated) |
object (ChannelWithScore )
Output only. Current channels with scores.
|
device.grantRangeAllowlists[] |
object (FrequencyRange )
Only ranges that are within the allowlists are available for new grants.
|
Response body
If successful, the response body is empty.
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.
[[["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."],[[["Signs a device, using the provided device information in the request body."],["The HTTP request is a POST request to the specified URL with the device name as a path parameter."],["The request body requires device details like FCC ID, serial number, configuration, and operational state."],["Authorization requires the `https://www.googleapis.com/auth/sasportal` scope."]]],["This document outlines how to sign a device using a `POST` HTTP request to `https://sasportal.googleapis.com/v1alpha1/{device.name=nodes/*/devices/*}:signDevice`. The request includes a JSON body with the `device` object, where we can define its attributes. Important fields include `fccId`, `serialNumber`, `preloadedConfig`, `activeConfig`, `state`, `grants`, `displayName`, `deviceMetadata` and `grantRangeAllowlists`. The `device.name` parameter is a string representing the resource path name. A successful request returns an empty response body and requires `https://www.googleapis.com/auth/sasportal` OAuth scope.\n"]]