Method: customers.policies.groups.listGroupPriorityOrdering
Stay organized with collections
Save and categorize content based on your preferences.
Retrieve a group priority ordering for an app. The target app must be supplied in additionalTargetKeyNames in the PolicyTargetKey. On failure the request will return the error details as part of the google.rpc.Status.
HTTP request
POST https://chromepolicy.googleapis.com/v1/{customer=customers/*}/policies/groups:listGroupPriorityOrdering
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
customer |
string
Required. ID of the Google Workspace account or literal "my_customer" for the customer associated to the request.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"policyTargetKey": {
object (PolicyTargetKey)
},
"policyNamespace": string,
"policySchema": string
} |
| Fields |
policyTargetKey |
object (PolicyTargetKey)
Required. The key of the target for which we want to retrieve the group priority ordering. The target resource must point to an app.
|
policyNamespace |
string
The namespace of the policy type for the request.
|
policySchema |
string
The schema name of the policy for the request.
|
Response body
Response message for listing the group priority ordering of an app.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"policyTargetKey": {
object (PolicyTargetKey)
},
"policyNamespace": string,
"policySchema": string,
"groupIds": [
string
]
} |
| Fields |
policyTargetKey |
object (PolicyTargetKey)
Output only. The target resource for which the group priority ordering has been retrieved.
|
policyNamespace |
string
Output only. The namespace of the policy type of the group IDs.
|
policySchema |
string
Output only. The schema name of the policy for the group IDs.
|
groupIds[] |
string
Output only. The group IDs, in priority ordering.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/chrome.management.policy.readonlyhttps://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.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieve the group priority ordering for an app within a Google Workspace account using this API endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires specifying the target app, policy namespace, and policy schema.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses provide the target resource, policy details, and a list of group IDs in priority order.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires specific OAuth scopes for Chrome management policies.\u003c/p\u003e\n"]]],[],null,["# Method: customers.policies.groups.listGroupPriorityOrdering\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListGroupPriorityOrderingResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieve a group priority ordering for an app. The target app must be supplied in `additionalTargetKeyNames` in the PolicyTargetKey. On failure the request will return the error details as part of the google.rpc.Status.\n\n### HTTP request\n\n`POST https://chromepolicy.googleapis.com/v1/{customer=customers/*}/policies/groups:listGroupPriorityOrdering`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` Required. ID of the Google Workspace account or literal \"my_customer\" for the customer associated to the request. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"policyTargetKey\": { object (/chrome/policy/reference/rest/v1/PolicyTargetKey) }, \"policyNamespace\": string, \"policySchema\": string } ``` |\n\n| Fields ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `policyTargetKey` | `object (`[PolicyTargetKey](/chrome/policy/reference/rest/v1/PolicyTargetKey)`)` Required. The key of the target for which we want to retrieve the group priority ordering. The target resource must point to an app. |\n| `policyNamespace` | `string` The namespace of the policy type for the request. |\n| `policySchema` | `string` The schema name of the policy for the request. |\n\n### Response body\n\nResponse message for listing the group priority ordering of an app.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"policyTargetKey\": { object (/chrome/policy/reference/rest/v1/PolicyTargetKey) }, \"policyNamespace\": string, \"policySchema\": string, \"groupIds\": [ string ] } ``` |\n\n| Fields ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `policyTargetKey` | `object (`[PolicyTargetKey](/chrome/policy/reference/rest/v1/PolicyTargetKey)`)` Output only. The target resource for which the group priority ordering has been retrieved. |\n| `policyNamespace` | `string` Output only. The namespace of the policy type of the group IDs. |\n| `policySchema` | `string` Output only. The schema name of the policy for the group IDs. |\n| `groupIds[]` | `string` Output only. The group IDs, in priority ordering. |\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`"]]
