Method: customers.policies.groups.listGroupPriorityOrdering

  • This page describes how to retrieve a group priority ordering for a specific app using an HTTP POST request to the specified URL.

  • The request requires a customer ID as a path parameter and a request body containing the policy target key, namespace, and schema.

  • The response body contains the policy target key, namespace, schema, and a list of group IDs in priority order.

  • Authorization requires one of the listed OAuth scopes.

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.readonly
  • https://www.googleapis.com/auth/chrome.management.policy