Method: customers.policies.groups.batchModify

  • This API allows administrators to modify multiple policy values applied to a specific Google Workspace group.

  • All policy targets must share the same format, including the target resource and additionalTargetKeyNames.

  • The request body should contain a list of ModifyGroupPolicyRequest objects, each specifying the target, new policy value, and fields to update.

  • Successful requests will return an empty response body, while failures will include error details in the google.rpc.Status.

  • Authorization requires the https://www.googleapis.com/auth/chrome.management.policy OAuth scope.

Modify multiple policy values that are applied to a specific group. All targets must have the same target format. That is to say that they must point to the same target resource and must have the same keys specified in additionalTargetKeyNames, though the values for those keys may be different. 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:batchModify

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customer

string

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 
{
  "requests": [
    {
      object (ModifyGroupPolicyRequest)
    }
  ]
}
Fields
requests[]

object (ModifyGroupPolicyRequest)

List of policies to modify as defined by the requests. All requests in the list must follow these restrictions:

  1. All schemas in the list must have the same root namespace.
  2. All `policyTargetKey.targetResource` values must point to a group resource.
  3. All `policyTargetKey` values must have the same `appId` key name in the `additionalTargetKeys`.
  4. No two modification requests can reference the same `policySchema` + ` policyTargetKey` pair.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/chrome.management.policy

ModifyGroupPolicyRequest

Request parameters for modifying a policy value for a specific group target.

JSON representation 
{
  "policyTargetKey": {
    object (PolicyTargetKey)
  },
  "policyValue": {
    object (PolicyValue)
  },
  "updateMask": string
}
Fields
policyTargetKey

object (PolicyTargetKey)

Required. The key of the target for which we want to modify a policy. The target resource must point to a group.
policyValue

object (PolicyValue)

The new value for the policy.
updateMask

string (FieldMask format)

Required. Policy fields to update. Only fields in this mask will be updated; other fields in policyValue will be ignored (even if they have values). If a field is in this list it must have a value in 'policyValue'.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".