Method: customers.policies.orgunits.batchInherit
Stay organized with collections
Save and categorize content based on your preferences.
Modify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). 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/orgunits:batchInherit
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
customer |
string
ID of the G Suite 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 (InheritOrgUnitPolicyRequest)
List of policies that have to inherit their values 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 an org unit
resource.
- All `policyTargetKey` values must have the same key names in the
` additionalTargetKeys`. This also means if one of
the targets has an empty `additionalTargetKeys` map, all of the
targets must have an empty `additionalTargetKeys` map.
- 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
InheritOrgUnitPolicyRequest
Request parameters for inheriting policy value of a specific org unit target from the policy value of its parent org unit.
| JSON representation |
{
"policyTargetKey": {
object (PolicyTargetKey)
},
"policySchema": 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 an Org Unit.
|
policySchema |
string
The fully qualified name of the policy schema that is being inherited.
|
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\u003eAllows modifying multiple policy values applied to a specific organizational unit to inherit from a parent.\u003c/p\u003e\n"],["\u003cp\u003eRequires all target resources to have the same format, including keys specified in \u003ccode\u003eadditionalTargetKeyNames\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003ePOST\u003c/code\u003e request to \u003ccode\u003ehttps://chromepolicy.googleapis.com/v1/{customer=customers/*}/policies/orgunits:batchInherit\u003c/code\u003e with necessary path and request body parameters.\u003c/p\u003e\n"],["\u003cp\u003eDemands authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/chrome.management.policy\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReturns an empty response body upon successful execution, and error details within \u003ccode\u003egoogle.rpc.Status\u003c/code\u003e on failure.\u003c/p\u003e\n"]]],[],null,["# Method: customers.policies.orgunits.batchInherit\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- [InheritOrgUnitPolicyRequest](#InheritOrgUnitPolicyRequest)\n - [JSON representation](#InheritOrgUnitPolicyRequest.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nModify multiple policy values that are applied to a specific org unit so that they now inherit the value from a parent (if applicable). 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/orgunits:batchInherit`\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 G Suite 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.orgunits/batchInherit#InheritOrgUnitPolicyRequest) } ] } ``` |\n\n| Fields ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requests[]` | `object (`[InheritOrgUnitPolicyRequest](/chrome/policy/reference/rest/v1/customers.policies.orgunits/batchInherit#InheritOrgUnitPolicyRequest)`)` List of policies that have to inherit their values 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 an org unit resource. 3. All \\`policyTargetKey\\` values must have the same key names in the \\` additionalTargetKeys\\`. This also means if one of the targets has an empty \\`additionalTargetKeys\\` map, all of the targets must have an empty \\`additionalTargetKeys\\` map. 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\nInheritOrgUnitPolicyRequest\n---------------------------\n\nRequest parameters for inheriting policy value of a specific org unit target from the policy value of its parent org unit.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"policyTargetKey\": { object (/chrome/policy/reference/rest/v1/PolicyTargetKey) }, \"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 modify a policy. The target resource must point to an Org Unit. |\n| `policySchema` | `string` The fully qualified name of the policy schema that is being inherited. |"]]
