Method: customers.policySchemas.list
Stay organized with collections
Save and categorize content based on your preferences.
Gets a list of policy schemas that match a specified filter value for a given customer.
HTTP request
GET https://chromepolicy.googleapis.com/v1/{parent=customers/*}/policySchemas
The URL uses gRPC Transcoding
syntax.
Path parameters
Parameters |
parent
|
string
Required. The customer for which the listing request will apply.
|
Query parameters
Parameters |
filter
|
string
The schema filter used to find a particular schema based on fields like its resource name, description and additionalTargetKeyNames
.
|
pageSize
|
integer
The maximum number of policy schemas to return, defaults to 100 and has a maximum of 1000.
|
pageToken
|
string
The page token used to retrieve a specific page of the listing request.
|
Request body
The request body must be empty.
Response body
Response message for listing policy schemas that match a filter.
If successful, the response body contains data with the following structure:
Fields |
policySchemas[]
|
object ( PolicySchema
)
The list of policy schemas that match the query.
|
nextPageToken
|
string
The page token used to get the next page of policy schemas.
|
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/chrome.management.policy.readonly
-
https://www.googleapis.com/auth/chrome.management.policy
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 2024-10-16 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 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of policy schemas for a specific customer based on filter criteria.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by resource name, description, and additional target key names.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large result sets.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of matching policy schemas and a token for accessing the next page.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific OAuth scopes for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: customers.policySchemas.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPolicySchemasResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets a list of policy schemas that match a specified filter value for a given customer.\n\n### HTTP request\n\n`GET https://chromepolicy.googleapis.com/v1/{parent=customers/*}/policySchemas`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------|\n| `parent` | `string` Required. The customer for which the listing request will apply. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` The schema filter used to find a particular schema based on fields like its resource name, description and `additionalTargetKeyNames`. |\n| `pageSize` | `integer` The maximum number of policy schemas to return, defaults to 100 and has a maximum of 1000. |\n| `pageToken` | `string` The page token used to retrieve a specific page of the listing request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for listing policy schemas that match a filter.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"policySchemas\": [ { object (/chrome/policy/reference/rest/v1/customers.policySchemas#PolicySchema) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `policySchemas[]` | `object (`[PolicySchema](/chrome/policy/reference/rest/v1/customers.policySchemas#PolicySchema)`)` The list of policy schemas that match the query. |\n| `nextPageToken` | `string` The page token used to get the next page of policy schemas. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chrome.management.policy.readonly`\n- `https://www.googleapis.com/auth/chrome.management.policy`"]]