1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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.groups.html">groups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete 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.</p>
<p class="toc_element">
<code><a href="#batchModify">batchModify(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#listGroupPriorityOrdering">listGroupPriorityOrdering(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#updateGroupPriorityOrdering">updateGroupPriorityOrdering(customer, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update 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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchDelete">batchDelete(customer, body=None, x__xgafv=None)</code>
<pre>Delete 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.
Args:
customer: string, ID of the Google Workspace account or literal "my_customer" for the customer associated to the request. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for specifying that multiple policy values will be deleted.
"requests": [ # List of policies that will be deleted 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 `app_id` key name in the `additionalTargetKeys`. 4. No two modification requests can reference the same `policySchema` + ` policyTargetKey` pair.
{ # Request parameters for deleting the policy value of a specific group target.
"policySchema": "A String", # The fully qualified name of the policy schema that is being inherited.
"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 a Group.
"additionalTargetKeys": { # Map containing the additional target key name and value pairs used to further identify the target of the policy.
"a_key": "A String",
},
"targetResource": "A String", # The target resource on which this policy is applied. The following resources are supported: * Organizational Unit ("orgunits/{orgunit_id}") * Group ("groups/{group_id}")
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="batchModify">batchModify(customer, body=None, x__xgafv=None)</code>
<pre>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.
Args:
customer: string, ID of the Google Workspace account or literal "my_customer" for the customer associated to the request. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for modifying multiple policy values for a specific group-based target.
"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 a group resource. 3. All `policyTargetKey` values must have the same `app_id` key name in the `additionalTargetKeys`. 4. No two modification requests can reference the same `policySchema` + ` policyTargetKey` pair.
{ # Request parameters for modifying a policy value for a specific group target.
"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 a Group.
"additionalTargetKeys": { # Map containing the additional target key name and value pairs used to further identify the target of the policy.
"a_key": "A String",
},
"targetResource": "A String", # The target resource on which this policy is applied. The following resources are supported: * Organizational Unit ("orgunits/{orgunit_id}") * Group ("groups/{group_id}")
},
"policyValue": { # A particular value for a policy managed by the service. # The new value for the policy.
"policySchema": "A String", # The fully qualified name of the policy schema associated with this policy.
"value": { # The value of the policy that is compatible with the schema that it is associated with.
"a_key": "", # Properties of the object.
},
},
"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'.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="listGroupPriorityOrdering">listGroupPriorityOrdering(customer, body=None, x__xgafv=None)</code>
<pre>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.
Args:
customer: string, Required. ID of the Google Workspace account or literal "my_customer" for the customer associated to the request. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for listing the group priority ordering of an app.
"policyNamespace": "A String", # The namespace of the policy type for the request.
"policySchema": "A String", # The schema name of the policy for the request.
"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 retrieve the group priority ordering. The target resource must point to an app.
"additionalTargetKeys": { # Map containing the additional target key name and value pairs used to further identify the target of the policy.
"a_key": "A String",
},
"targetResource": "A String", # The target resource on which this policy is applied. The following resources are supported: * Organizational Unit ("orgunits/{orgunit_id}") * Group ("groups/{group_id}")
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing the group priority ordering of an app.
"groupIds": [ # Output only. The group IDs, in priority ordering.
"A String",
],
"policyNamespace": "A String", # Output only. The namespace of the policy type of the group IDs.
"policySchema": "A String", # Output only. The schema name of the policy for the group IDs.
"policyTargetKey": { # The key used to identify the target on which the policy will be applied. # Output only. The target resource for which the group priority ordering has been retrieved.
"additionalTargetKeys": { # Map containing the additional target key name and value pairs used to further identify the target of the policy.
"a_key": "A String",
},
"targetResource": "A String", # The target resource on which this policy is applied. The following resources are supported: * Organizational Unit ("orgunits/{orgunit_id}") * Group ("groups/{group_id}")
},
}</pre>
</div>
<div class="method">
<code class="details" id="updateGroupPriorityOrdering">updateGroupPriorityOrdering(customer, body=None, x__xgafv=None)</code>
<pre>Update 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.
Args:
customer: string, Required. ID of the Google Workspace account or literal "my_customer" for the customer associated to the request. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for updating the group priority ordering of an app.
"groupIds": [ # Required. The group IDs, in desired priority ordering.
"A String",
],
"policyNamespace": "A String", # The namespace of the policy type for the request.
"policySchema": "A String", # The schema name of the policy for the request.
"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 update the group priority ordering. The target resource must point to an app.
"additionalTargetKeys": { # Map containing the additional target key name and value pairs used to further identify the target of the policy.
"a_key": "A String",
},
"targetResource": "A String", # The target resource on which this policy is applied. The following resources are supported: * Organizational Unit ("orgunits/{orgunit_id}") * Group ("groups/{group_id}")
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
</body></html>
|
