Method: customers.policies.groups.batchModify
Stay organized with collections
Save and categorize content based on your preferences.
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:
| Fields |
requests[] |
object (ModifyGroupPolicyRequest)
List of policies to modify as defined by the requests. All requests in the list must follow these restrictions:
- All schemas in the list must have the same root namespace.
- All `policyTargetKey.targetResource` values must point to a group
resource.
- All `policyTargetKey` values must have the same `appId` key name in
the `additionalTargetKeys`.
- 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".
|
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\u003eThis API allows administrators to modify multiple policy values applied to a specific Google Workspace group.\u003c/p\u003e\n"],["\u003cp\u003eAll policy targets must share the same format, including the target resource and \u003ccode\u003eadditionalTargetKeyNames\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a list of \u003ccode\u003eModifyGroupPolicyRequest\u003c/code\u003e objects, each specifying the target, new policy value, and fields to update.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return an empty response body, while failures will include error details in the \u003ccode\u003egoogle.rpc.Status\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/chrome.management.policy\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: customers.policies.groups.batchModify\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- [Authorization scopes](#body.aspect)\n- [ModifyGroupPolicyRequest](#ModifyGroupPolicyRequest)\n - [JSON representation](#ModifyGroupPolicyRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nModify 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.\n\n### HTTP request\n\n`POST https://chromepolicy.googleapis.com/v1/{customer=customers/*}/policies/groups:batchModify`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` 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| ``` { \"requests\": [ { object (/chrome/policy/reference/rest/v1/customers.policies.groups/batchModify#ModifyGroupPolicyRequest) } ] } ``` |\n\n| Fields ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requests[]` | `object (`[ModifyGroupPolicyRequest](/chrome/policy/reference/rest/v1/customers.policies.groups/batchModify#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. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/chrome.management.policy`\n\nModifyGroupPolicyRequest\n------------------------\n\nRequest parameters for modifying a policy value for a specific group target.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"policyTargetKey\": { object (/chrome/policy/reference/rest/v1/PolicyTargetKey) }, \"policyValue\": { object (/chrome/policy/reference/rest/v1/PolicyValue) }, \"updateMask\": 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 modify a policy. The target resource must point to a group. |\n| `policyValue` | `object (`[PolicyValue](/chrome/policy/reference/rest/v1/PolicyValue)`)` The new value for the policy. |\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |"]]
