Method: policies.test
Stay organized with collections
Save and categorize content based on your preferences.
Returns permissions that a caller has on the specified resource.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/policies:test
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 permissions are being requested.
|
permissions[]
|
string
The set of permissions to check for the resource
.
|
Response body
If successful, the response body contains data with the following structure:
Response message for policies.test
method.
| Fields |
permissions[]
|
string
A set of permissions that the caller is allowed.
|
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\u003eTests permissions that a caller has on a specified resource.\u003c/p\u003e\n"],["\u003cp\u003eTakes a resource and a set of permissions as input in the request body.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of allowed permissions in the response body.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e authorization scope for access.\u003c/p\u003e\n"]]],["The document outlines the `POST` request to `https://sasportal.googleapis.com/v1alpha1/policies:test` for testing permissions on a specified resource. The request body requires a `resource` string and an array of `permissions` strings. The response body, upon success, returns an array of `permissions` strings, representing the caller's allowed permissions. This process necessitates authorization with the `https://www.googleapis.com/auth/sasportal` OAuth scope.\n"],null,["# Method: policies.test\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 - [JSON representation](#body.TestPermissionsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nReturns permissions that a caller has on the specified resource.\n\n### HTTP request\n\n`POST https://sasportal.googleapis.com/v1alpha1/policies:test`\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, \"permissions\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------|\n| `resource` | `string` Required. The resource for which the permissions are being requested. |\n| `permissions[]` | `string` The set of permissions to check for the `resource`. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for `policies.test` method.\n\n| JSON representation |\n|---------------------------------------|\n| ``` { \"permissions\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------|\n| `permissions[]` | `string` A set of permissions that the caller is allowed. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]
