Method: policies.set
Stay organized with collections
Save and categorize content based on your preferences.
Sets the access control policy on the specified resource. Replaces any existing policy.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/policies:set
The URL uses gRPC Transcoding
syntax.
Request body
The request body contains data with the following structure:
| Fields |
resource
|
string
Required. The resource for which the policy is being specified. This policy replaces any existing policy.
|
policy
|
object ( Policy
)
Required. The policy to be applied to the resource
.
|
disableNotification
|
boolean
Optional. Set the field as true
to disable the onboarding notification.
|
Response body
If successful, the response body contains an instance of Policy
.
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."],[[["\u003cp\u003eSets the access control policy on a specified resource, replacing any existing policy.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires the resource, the policy to be applied, and optionally allows disabling onboarding notifications.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the applied policy.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["The core function is to set an access control policy on a resource via a `POST` HTTP request to `https://sasportal.googleapis.com/v1alpha1/policies:set`. The request body, in JSON format, requires a `resource` string and a `policy` object. Optionally, `disableNotification` can be set to `true`. A successful request returns a `Policy` instance. This process requires the `https://www.googleapis.com/auth/sasportal` OAuth scope. Existing policies are replaced.\n"],null,["# Method: policies.set\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\nSets the access control policy on the specified resource. Replaces any existing policy.\n\n### HTTP request\n\n`POST https://sasportal.googleapis.com/v1alpha1/policies:set`\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| ``` { \"resource\": string, \"policy\": { object (/spectrum-access-system/reference/rest/v1alpha1/Policy) }, \"disableNotification\": boolean } ``` |\n\n| Fields ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `resource` | `string` Required. The resource for which the policy is being specified. This policy replaces any existing policy. |\n| `policy` | `object (`[Policy](/spectrum-access-system/reference/rest/v1alpha1/Policy)`)` Required. The policy to be applied to the `resource`. |\n| `disableNotification` | `boolean` Optional. Set the field as `true` to disable the onboarding notification. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Policy](/spectrum-access-system/reference/rest/v1alpha1/Policy).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]
