Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / androiddeviceprovisioning_v1.customers.configurations.html
blob: 256b5b5dc6e6ff02ed76e0a0577b48c4ce93a680 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.customers.html">customers</a> . <a href="androiddeviceprovisioning_v1.customers.configurations.html">configurations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a new configuration. Once created, a customer can apply the</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an unused configuration. The API call fails if the customer has</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the details of a configuration.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists a customer's configurations.</p>
89<p class="toc_element">
90 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Updates a configuration's field values.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
95 <pre>Creates a new configuration. Once created, a customer can apply the
96configuration to devices.
97
98Args:
99 parent: string, Required. The customer that manages the configuration. An API resource name
100in the format `customers/[CUSTOMER_ID]`. (required)
101 body: object, The request body. (required)
102 The object takes the form of:
103
104{ # A configuration collects the provisioning options for Android devices. Each
105 # configuration combines the following:
106 #
107 # * The EMM device policy controller (DPC) installed on the devices.
108 # * EMM policies enforced on the devices.
109 # * Metadata displayed on the device to help users during setup.
110 #
111 # Customers can add as many configurations as they need. However, zero-touch
112 # enrollment works best when a customer sets a default configuration that's
113 # applied to any new devices the organization purchases.
114 "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
115 "contactPhone": "A String", # Required. The telephone number that device users can call, using another
116 # device, to get help. Zero-touch enrollment shows this number to device
117 # users before device provisioning. Accepts numerals, spaces, the plus sign,
118 # hyphens, and parentheses.
119 "name": "A String", # Output only. The API resource name in the format
120 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
121 # the server.
122 "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
123 # organization name to device users during device provisioning.
124 "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
125 "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
126 # or give them more details about what’s happening to their device.
127 # Zero-touch enrollment shows this message before the device is provisioned.
128 "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
129 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
130 # call
131 # `customers.dpcs.list`.
132 "contactEmail": "A String", # Required. The email address that device users can contact to get help.
133 # Zero-touch enrollment shows this email address to device users before
134 # device provisioning. The value is validated on input.
135 "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
136 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
137 # portal displays this name to IT admins.
138 "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
139 # enrollment applies to any new devices the organization purchases in the
140 # future. Only one customer configuration can be the default. Setting this
141 # value to `true`, changes the previous default configuration's `isDefault`
142 # value to `false`.
143 }
144
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150Returns:
151 An object of the form:
152
153 { # A configuration collects the provisioning options for Android devices. Each
154 # configuration combines the following:
155 #
156 # * The EMM device policy controller (DPC) installed on the devices.
157 # * EMM policies enforced on the devices.
158 # * Metadata displayed on the device to help users during setup.
159 #
160 # Customers can add as many configurations as they need. However, zero-touch
161 # enrollment works best when a customer sets a default configuration that's
162 # applied to any new devices the organization purchases.
163 "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
164 "contactPhone": "A String", # Required. The telephone number that device users can call, using another
165 # device, to get help. Zero-touch enrollment shows this number to device
166 # users before device provisioning. Accepts numerals, spaces, the plus sign,
167 # hyphens, and parentheses.
168 "name": "A String", # Output only. The API resource name in the format
169 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
170 # the server.
171 "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
172 # organization name to device users during device provisioning.
173 "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
174 "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
175 # or give them more details about what’s happening to their device.
176 # Zero-touch enrollment shows this message before the device is provisioned.
177 "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
178 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
179 # call
180 # `customers.dpcs.list`.
181 "contactEmail": "A String", # Required. The email address that device users can contact to get help.
182 # Zero-touch enrollment shows this email address to device users before
183 # device provisioning. The value is validated on input.
184 "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
185 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
186 # portal displays this name to IT admins.
187 "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
188 # enrollment applies to any new devices the organization purchases in the
189 # future. Only one customer configuration can be the default. Setting this
190 # value to `true`, changes the previous default configuration's `isDefault`
191 # value to `false`.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
197 <pre>Deletes an unused configuration. The API call fails if the customer has
198devices with the configuration applied.
199
200Args:
201 name: string, Required. The configuration to delete. An API resource name in the format
202`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the
203configuration is applied to any devices, the API call fails. (required)
204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
208
209Returns:
210 An object of the form:
211
212 { # A generic empty message that you can re-use to avoid defining duplicated
213 # empty messages in your APIs. A typical example is to use it as the request
214 # or the response type of an API method. For instance:
215 #
216 # service Foo {
217 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
218 # }
219 #
220 # The JSON representation for `Empty` is empty JSON object `{}`.
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="get">get(name, x__xgafv=None)</code>
226 <pre>Gets the details of a configuration.
227
228Args:
229 name: string, Required. The configuration to get. An API resource name in the format
230`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. (required)
231 x__xgafv: string, V1 error format.
232 Allowed values
233 1 - v1 error format
234 2 - v2 error format
235
236Returns:
237 An object of the form:
238
239 { # A configuration collects the provisioning options for Android devices. Each
240 # configuration combines the following:
241 #
242 # * The EMM device policy controller (DPC) installed on the devices.
243 # * EMM policies enforced on the devices.
244 # * Metadata displayed on the device to help users during setup.
245 #
246 # Customers can add as many configurations as they need. However, zero-touch
247 # enrollment works best when a customer sets a default configuration that's
248 # applied to any new devices the organization purchases.
249 "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
250 "contactPhone": "A String", # Required. The telephone number that device users can call, using another
251 # device, to get help. Zero-touch enrollment shows this number to device
252 # users before device provisioning. Accepts numerals, spaces, the plus sign,
253 # hyphens, and parentheses.
254 "name": "A String", # Output only. The API resource name in the format
255 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
256 # the server.
257 "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
258 # organization name to device users during device provisioning.
259 "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
260 "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
261 # or give them more details about what’s happening to their device.
262 # Zero-touch enrollment shows this message before the device is provisioned.
263 "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
264 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
265 # call
266 # `customers.dpcs.list`.
267 "contactEmail": "A String", # Required. The email address that device users can contact to get help.
268 # Zero-touch enrollment shows this email address to device users before
269 # device provisioning. The value is validated on input.
270 "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
271 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
272 # portal displays this name to IT admins.
273 "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
274 # enrollment applies to any new devices the organization purchases in the
275 # future. Only one customer configuration can be the default. Setting this
276 # value to `true`, changes the previous default configuration's `isDefault`
277 # value to `false`.
278 }</pre>
279</div>
280
281<div class="method">
282 <code class="details" id="list">list(parent, x__xgafv=None)</code>
283 <pre>Lists a customer's configurations.
284
285Args:
286 parent: string, Required. The customer that manages the listed configurations. An API
287resource name in the format `customers/[CUSTOMER_ID]`. (required)
288 x__xgafv: string, V1 error format.
289 Allowed values
290 1 - v1 error format
291 2 - v2 error format
292
293Returns:
294 An object of the form:
295
296 { # Response message of customer's listing configuration.
297 "configurations": [ # The configurations.
298 { # A configuration collects the provisioning options for Android devices. Each
299 # configuration combines the following:
300 #
301 # * The EMM device policy controller (DPC) installed on the devices.
302 # * EMM policies enforced on the devices.
303 # * Metadata displayed on the device to help users during setup.
304 #
305 # Customers can add as many configurations as they need. However, zero-touch
306 # enrollment works best when a customer sets a default configuration that's
307 # applied to any new devices the organization purchases.
308 "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
309 "contactPhone": "A String", # Required. The telephone number that device users can call, using another
310 # device, to get help. Zero-touch enrollment shows this number to device
311 # users before device provisioning. Accepts numerals, spaces, the plus sign,
312 # hyphens, and parentheses.
313 "name": "A String", # Output only. The API resource name in the format
314 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
315 # the server.
316 "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
317 # organization name to device users during device provisioning.
318 "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
319 "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
320 # or give them more details about what’s happening to their device.
321 # Zero-touch enrollment shows this message before the device is provisioned.
322 "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
323 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
324 # call
325 # `customers.dpcs.list`.
326 "contactEmail": "A String", # Required. The email address that device users can contact to get help.
327 # Zero-touch enrollment shows this email address to device users before
328 # device provisioning. The value is validated on input.
329 "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
330 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
331 # portal displays this name to IT admins.
332 "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
333 # enrollment applies to any new devices the organization purchases in the
334 # future. Only one customer configuration can be the default. Setting this
335 # value to `true`, changes the previous default configuration's `isDefault`
336 # value to `false`.
337 },
338 ],
339 }</pre>
340</div>
341
342<div class="method">
343 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
344 <pre>Updates a configuration's field values.
345
346Args:
347 name: string, Output only. The API resource name in the format
348`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
349the server. (required)
350 body: object, The request body. (required)
351 The object takes the form of:
352
353{ # A configuration collects the provisioning options for Android devices. Each
354 # configuration combines the following:
355 #
356 # * The EMM device policy controller (DPC) installed on the devices.
357 # * EMM policies enforced on the devices.
358 # * Metadata displayed on the device to help users during setup.
359 #
360 # Customers can add as many configurations as they need. However, zero-touch
361 # enrollment works best when a customer sets a default configuration that's
362 # applied to any new devices the organization purchases.
363 "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
364 "contactPhone": "A String", # Required. The telephone number that device users can call, using another
365 # device, to get help. Zero-touch enrollment shows this number to device
366 # users before device provisioning. Accepts numerals, spaces, the plus sign,
367 # hyphens, and parentheses.
368 "name": "A String", # Output only. The API resource name in the format
369 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
370 # the server.
371 "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
372 # organization name to device users during device provisioning.
373 "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
374 "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
375 # or give them more details about what’s happening to their device.
376 # Zero-touch enrollment shows this message before the device is provisioned.
377 "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
378 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
379 # call
380 # `customers.dpcs.list`.
381 "contactEmail": "A String", # Required. The email address that device users can contact to get help.
382 # Zero-touch enrollment shows this email address to device users before
383 # device provisioning. The value is validated on input.
384 "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
385 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
386 # portal displays this name to IT admins.
387 "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
388 # enrollment applies to any new devices the organization purchases in the
389 # future. Only one customer configuration can be the default. Setting this
390 # value to `true`, changes the previous default configuration's `isDefault`
391 # value to `false`.
392 }
393
394 updateMask: string, Required. The field mask applied to the target `Configuration` before
395updating the fields. To learn more about using field masks, read
396[FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in
397the Protocol Buffers documentation.
398 x__xgafv: string, V1 error format.
399 Allowed values
400 1 - v1 error format
401 2 - v2 error format
402
403Returns:
404 An object of the form:
405
406 { # A configuration collects the provisioning options for Android devices. Each
407 # configuration combines the following:
408 #
409 # * The EMM device policy controller (DPC) installed on the devices.
410 # * EMM policies enforced on the devices.
411 # * Metadata displayed on the device to help users during setup.
412 #
413 # Customers can add as many configurations as they need. However, zero-touch
414 # enrollment works best when a customer sets a default configuration that's
415 # applied to any new devices the organization purchases.
416 "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC.
417 "contactPhone": "A String", # Required. The telephone number that device users can call, using another
418 # device, to get help. Zero-touch enrollment shows this number to device
419 # users before device provisioning. Accepts numerals, spaces, the plus sign,
420 # hyphens, and parentheses.
421 "name": "A String", # Output only. The API resource name in the format
422 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
423 # the server.
424 "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this
425 # organization name to device users during device provisioning.
426 "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server.
427 "customMessage": "A String", # A message, containing one or two sentences, to help device users get help
428 # or give them more details about what’s happening to their device.
429 # Zero-touch enrollment shows this message before the device is provisioned.
430 "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller)
431 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
432 # call
433 # `customers.dpcs.list`.
434 "contactEmail": "A String", # Required. The email address that device users can contact to get help.
435 # Zero-touch enrollment shows this email address to device users before
436 # device provisioning. The value is validated on input.
437 "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For
438 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
439 # portal displays this name to IT admins.
440 "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch
441 # enrollment applies to any new devices the organization purchases in the
442 # future. Only one customer configuration can be the default. Setting this
443 # value to `true`, changes the previous default configuration's `isDefault`
444 # value to `false`.
445 }</pre>
446</div>
447
448</body></html>