Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="chromepolicy_v1.html">Chrome Policy API</a> . <a href="chromepolicy_v1.customers.html">customers</a> . <a href="chromepolicy_v1.customers.policies.html">policies</a> . <a href="chromepolicy_v1.customers.policies.orgunits.html">orgunits</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#batchInherit">batchInherit(customer, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">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`. On failure the request will return the error details as part of the google.rpc.Status.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#batchModify">batchModify(customer, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Modify multiple policy values that are applied to a specific org unit. 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`. On failure the request will return the error details as part of the google.rpc.Status.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#close">close()</a></code></p> |
| 85 | <p class="firstline">Close httplib2 connections.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="batchInherit">batchInherit(customer, body=None, x__xgafv=None)</code> |
| 89 | <pre>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`. On failure the request will return the error details as part of the google.rpc.Status. |
| 90 | |
| 91 | Args: |
| 92 | customer: string, ID of the G Suite account or literal "my_customer" for the customer associated to the request. (required) |
| 93 | body: object, The request body. |
| 94 | The object takes the form of: |
| 95 | |
| 96 | { # Request message for specifying that multiple policy values inherit their value from their parents. |
| 97 | "requests": [ # 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. |
| 98 | { # Request parameters for inheriting policy value of a specific org unit target from the policy value of its parent org unit. |
| 99 | "policySchema": "A String", # The fully qualified name of the policy schema that is being inherited. |
| 100 | "policyTargetKey": { # The key used to identify the target on which the policy will be applied. # Required. The key of the target for which we want to modify a policy. The target resource must point to an Org Unit. |
| 101 | "additionalTargetKeys": { # Map containing the additional target key name and value pairs used to further identify the target of the policy. |
| 102 | "a_key": "A String", |
| 103 | }, |
| 104 | "targetResource": "A String", # The target resource on which this policy is applied. The following resources are supported: * Organizational Unit ("orgunits/{orgunit_id}") |
| 105 | }, |
| 106 | }, |
| 107 | ], |
| 108 | } |
| 109 | |
| 110 | x__xgafv: string, V1 error format. |
| 111 | Allowed values |
| 112 | 1 - v1 error format |
| 113 | 2 - v2 error format |
| 114 | |
| 115 | Returns: |
| 116 | An object of the form: |
| 117 | |
| 118 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| 119 | }</pre> |
| 120 | </div> |
| 121 | |
| 122 | <div class="method"> |
| 123 | <code class="details" id="batchModify">batchModify(customer, body=None, x__xgafv=None)</code> |
| 124 | <pre>Modify multiple policy values that are applied to a specific org unit. 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`. On failure the request will return the error details as part of the google.rpc.Status. |
| 125 | |
| 126 | Args: |
| 127 | customer: string, ID of the G Suite account or literal "my_customer" for the customer associated to the request. (required) |
| 128 | body: object, The request body. |
| 129 | The object takes the form of: |
| 130 | |
| 131 | { # Request message for modifying multiple policy values for a specific target. |
| 132 | "requests": [ # 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 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. |
| 133 | { # Request parameters for modifying a policy value for a specific org unit target. |
| 134 | "policyTargetKey": { # The key used to identify the target on which the policy will be applied. # Required. The key of the target for which we want to modify a policy. The target resource must point to an Org Unit. |
| 135 | "additionalTargetKeys": { # Map containing the additional target key name and value pairs used to further identify the target of the policy. |
| 136 | "a_key": "A String", |
| 137 | }, |
| 138 | "targetResource": "A String", # The target resource on which this policy is applied. The following resources are supported: * Organizational Unit ("orgunits/{orgunit_id}") |
| 139 | }, |
| 140 | "policyValue": { # A particular value for a policy managed by the service. # The new value for the policy. |
| 141 | "policySchema": "A String", # The fully qualified name of the policy schema associated with this policy. |
| 142 | "value": { # The value of the policy that is compatible with the schema that it is associated with. |
| 143 | "a_key": "", # Properties of the object. |
| 144 | }, |
| 145 | }, |
| 146 | "updateMask": "A String", # Required. Policy fields to update. Only fields in this mask will be updated; other fields in `policy_value` will be ignored (even if they have values). If a field is in this list it must have a value in 'policy_value'. |
| 147 | }, |
| 148 | ], |
| 149 | } |
| 150 | |
| 151 | x__xgafv: string, V1 error format. |
| 152 | Allowed values |
| 153 | 1 - v1 error format |
| 154 | 2 - v2 error format |
| 155 | |
| 156 | Returns: |
| 157 | An object of the form: |
| 158 | |
| 159 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| 160 | }</pre> |
| 161 | </div> |
| 162 | |
| 163 | <div class="method"> |
| 164 | <code class="details" id="close">close()</code> |
| 165 | <pre>Close httplib2 connections.</pre> |
| 166 | </div> |
| 167 | |
| 168 | </body></html> |