Method: installer.validate
Stay organized with collections
Save and categorize content based on your preferences.
Validates the identity of a Certified Professional Installer (CPI).
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/installer:validate
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
| JSON representation |
{
"installerId": string,
"secret": string,
"encodedSecret": string
} |
| Fields |
installerId |
string
Required. Unique installer id (CPI ID) from the Certified Professional Installers database.
|
secret |
string
Required. Secret returned by the installer.generateSecret.
|
encodedSecret |
string
Required. JSON Web Token signed using a CPI private key. Payload must include a "secret" claim whose value is the secret.
|
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.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eValidates the identity of a Certified Professional Installer (CPI) using a provided installer ID, secret, and encoded secret.\u003c/p\u003e\n"],["\u003cp\u003eThe request is sent as a \u003ccode\u003ePOST\u003c/code\u003e request to the specific endpoint \u003ccode\u003ehttps://sasportal.googleapis.com/v1alpha1/installer:validate\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful validation results in an empty response body.\u003c/p\u003e\n"]]],["The core actions involve validating a Certified Professional Installer (CPI). This is done via a `POST` request to `https://sasportal.googleapis.com/v1alpha1/installer:validate`. The request body, formatted as JSON, requires three string fields: `installerId` (CPI ID), `secret` (from `installer.generateSecret`), and `encodedSecret` (a JWT signed by the CPI's private key with a \"secret\" claim). A successful request returns an empty response body. Authorization requires the `https://www.googleapis.com/auth/sasportal` OAuth scope.\n"],null,["# Method: installer.validate\n\n- [HTTP request](#body.HTTP_TEMPLATE)\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\nValidates the identity of a Certified Professional Installer (CPI).\n\n### HTTP request\n\n`POST https://sasportal.googleapis.com/v1alpha1/installer:validate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------|\n| ``` { \"installerId\": string, \"secret\": string, \"encodedSecret\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `installerId` | `string` Required. Unique installer id (CPI ID) from the Certified Professional Installers database. |\n| `secret` | `string` Required. Secret returned by the [installer.generateSecret](/spectrum-access-system/reference/rest/v1alpha1/installer/generateSecret#spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret). |\n| `encodedSecret` | `string` Required. JSON Web Token signed using a CPI private key. Payload must include a \"secret\" claim whose value is the secret. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]