Method: customers.devices.patch

  • This documentation outlines how to update a device using the Spectrum Access System API with a PATCH request to a specified endpoint.

  • The request involves path and query parameters, including device.name for device identification and updateMask for specifying fields to update.

  • Both the request and response bodies utilize the Device object, detailed in external documentation.

  • Proper authorization requires the https://www.googleapis.com/auth/userinfo.email OAuth scope.

Updates a device.

HTTP request

PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=customers/*/devices/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
device.name

string

Output only. The resource path name.

Query parameters

Parameters
updateMask

string (FieldMask format)

Fields to be updated.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Device.

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