Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / androiddeviceprovisioning_v1.customers.configurations.html
blob: de6e3476eb6e66a762341b2b68dafe9eed74290f [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Updates a configuration's field values.</p>
92<h3>Method Details</h3>
93<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 # enrollment works best when a customer sets a default configuration that&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 # applied to any new devices the organization purchases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;customMessage&quot;: &quot;A String&quot;, # A message, containing one or two sentences, to help device users get help
115 # or give them more details about what’s happening to their device.
116 # Zero-touch enrollment shows this message before the device is provisioned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]117 &quot;configurationId&quot;: &quot;A String&quot;, # Output only. The ID of the configuration. Assigned by the server.
118 &quot;contactPhone&quot;: &quot;A String&quot;, # Required. The telephone number that device users can call, using another
119 # device, to get help. Zero-touch enrollment shows this number to device
120 # users before device provisioning. Accepts numerals, spaces, the plus sign,
121 # hyphens, and parentheses.
122 &quot;dpcResourcePath&quot;: &quot;A String&quot;, # Required. The resource name of the selected DPC (device policy controller)
123 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
124 # call
125 # `customers.dpcs.list`.
126 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the organization. Zero-touch enrollment shows this
127 # organization name to device users during device provisioning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;contactEmail&quot;: &quot;A String&quot;, # Required. The email address that device users can contact to get help.
129 # Zero-touch enrollment shows this email address to device users before
130 # device provisioning. The value is validated on input.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]131 &quot;dpcExtras&quot;: &quot;A String&quot;, # The JSON-formatted EMM provisioning extras that are passed to the DPC.
132 &quot;configurationName&quot;: &quot;A String&quot;, # Required. A short name that describes the configuration&#x27;s purpose. For
133 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
134 # portal displays this name to IT admins.
135 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
136 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
137 # the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;isDefault&quot;: True or False, # Required. Whether this is the default configuration that zero-touch
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 # enrollment applies to any new devices the organization purchases in the
140 # future. Only one customer configuration can be the default. Setting this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 # value to `true`, changes the previous default configuration&#x27;s `isDefault`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 # enrollment works best when a customer sets a default configuration that&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 # applied to any new devices the organization purchases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]163 &quot;customMessage&quot;: &quot;A String&quot;, # A message, containing one or two sentences, to help device users get help
164 # or give them more details about what’s happening to their device.
165 # Zero-touch enrollment shows this message before the device is provisioned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]166 &quot;configurationId&quot;: &quot;A String&quot;, # Output only. The ID of the configuration. Assigned by the server.
167 &quot;contactPhone&quot;: &quot;A String&quot;, # Required. The telephone number that device users can call, using another
168 # device, to get help. Zero-touch enrollment shows this number to device
169 # users before device provisioning. Accepts numerals, spaces, the plus sign,
170 # hyphens, and parentheses.
171 &quot;dpcResourcePath&quot;: &quot;A String&quot;, # Required. The resource name of the selected DPC (device policy controller)
172 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
173 # call
174 # `customers.dpcs.list`.
175 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the organization. Zero-touch enrollment shows this
176 # organization name to device users during device provisioning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]177 &quot;contactEmail&quot;: &quot;A String&quot;, # Required. The email address that device users can contact to get help.
178 # Zero-touch enrollment shows this email address to device users before
179 # device provisioning. The value is validated on input.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]180 &quot;dpcExtras&quot;: &quot;A String&quot;, # The JSON-formatted EMM provisioning extras that are passed to the DPC.
181 &quot;configurationName&quot;: &quot;A String&quot;, # Required. A short name that describes the configuration&#x27;s purpose. For
182 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
183 # portal displays this name to IT admins.
184 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
185 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
186 # the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;isDefault&quot;: True or False, # Required. Whether this is the default configuration that zero-touch
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 # enrollment applies to any new devices the organization purchases in the
189 # future. Only one customer configuration can be the default. Setting this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]190 # value to `true`, changes the previous default configuration&#x27;s `isDefault`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]247 # enrollment works best when a customer sets a default configuration that&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 # applied to any new devices the organization purchases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]249 &quot;customMessage&quot;: &quot;A String&quot;, # A message, containing one or two sentences, to help device users get help
250 # or give them more details about what’s happening to their device.
251 # Zero-touch enrollment shows this message before the device is provisioned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]252 &quot;configurationId&quot;: &quot;A String&quot;, # Output only. The ID of the configuration. Assigned by the server.
253 &quot;contactPhone&quot;: &quot;A String&quot;, # Required. The telephone number that device users can call, using another
254 # device, to get help. Zero-touch enrollment shows this number to device
255 # users before device provisioning. Accepts numerals, spaces, the plus sign,
256 # hyphens, and parentheses.
257 &quot;dpcResourcePath&quot;: &quot;A String&quot;, # Required. The resource name of the selected DPC (device policy controller)
258 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
259 # call
260 # `customers.dpcs.list`.
261 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the organization. Zero-touch enrollment shows this
262 # organization name to device users during device provisioning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]263 &quot;contactEmail&quot;: &quot;A String&quot;, # Required. The email address that device users can contact to get help.
264 # Zero-touch enrollment shows this email address to device users before
265 # device provisioning. The value is validated on input.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]266 &quot;dpcExtras&quot;: &quot;A String&quot;, # The JSON-formatted EMM provisioning extras that are passed to the DPC.
267 &quot;configurationName&quot;: &quot;A String&quot;, # Required. A short name that describes the configuration&#x27;s purpose. For
268 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
269 # portal displays this name to IT admins.
270 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
271 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
272 # the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]273 &quot;isDefault&quot;: True or False, # Required. Whether this is the default configuration that zero-touch
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 # enrollment applies to any new devices the organization purchases in the
275 # future. Only one customer configuration can be the default. Setting this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]276 # value to `true`, changes the previous default configuration&#x27;s `isDefault`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 <pre>Lists a customer&#x27;s configurations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]296 { # Response message of customer&#x27;s listing configuration.
297 &quot;configurations&quot;: [ # The configurations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]306 # enrollment works best when a customer sets a default configuration that&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 # applied to any new devices the organization purchases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]308 &quot;customMessage&quot;: &quot;A String&quot;, # A message, containing one or two sentences, to help device users get help
309 # or give them more details about what’s happening to their device.
310 # Zero-touch enrollment shows this message before the device is provisioned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]311 &quot;configurationId&quot;: &quot;A String&quot;, # Output only. The ID of the configuration. Assigned by the server.
312 &quot;contactPhone&quot;: &quot;A String&quot;, # Required. The telephone number that device users can call, using another
313 # device, to get help. Zero-touch enrollment shows this number to device
314 # users before device provisioning. Accepts numerals, spaces, the plus sign,
315 # hyphens, and parentheses.
316 &quot;dpcResourcePath&quot;: &quot;A String&quot;, # Required. The resource name of the selected DPC (device policy controller)
317 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
318 # call
319 # `customers.dpcs.list`.
320 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the organization. Zero-touch enrollment shows this
321 # organization name to device users during device provisioning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]322 &quot;contactEmail&quot;: &quot;A String&quot;, # Required. The email address that device users can contact to get help.
323 # Zero-touch enrollment shows this email address to device users before
324 # device provisioning. The value is validated on input.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]325 &quot;dpcExtras&quot;: &quot;A String&quot;, # The JSON-formatted EMM provisioning extras that are passed to the DPC.
326 &quot;configurationName&quot;: &quot;A String&quot;, # Required. A short name that describes the configuration&#x27;s purpose. For
327 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
328 # portal displays this name to IT admins.
329 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
330 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
331 # the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]332 &quot;isDefault&quot;: True or False, # Required. Whether this is the default configuration that zero-touch
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 # enrollment applies to any new devices the organization purchases in the
334 # future. Only one customer configuration can be the default. Setting this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]335 # value to `true`, changes the previous default configuration&#x27;s `isDefault`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]336 # value to `false`.
337 },
338 ],
339 }</pre>
340</div>
341
342<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]343 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]344 <pre>Updates a configuration&#x27;s field values.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]350 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]361 # enrollment works best when a customer sets a default configuration that&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]362 # applied to any new devices the organization purchases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]363 &quot;customMessage&quot;: &quot;A String&quot;, # A message, containing one or two sentences, to help device users get help
364 # or give them more details about what’s happening to their device.
365 # Zero-touch enrollment shows this message before the device is provisioned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]366 &quot;configurationId&quot;: &quot;A String&quot;, # Output only. The ID of the configuration. Assigned by the server.
367 &quot;contactPhone&quot;: &quot;A String&quot;, # Required. The telephone number that device users can call, using another
368 # device, to get help. Zero-touch enrollment shows this number to device
369 # users before device provisioning. Accepts numerals, spaces, the plus sign,
370 # hyphens, and parentheses.
371 &quot;dpcResourcePath&quot;: &quot;A String&quot;, # Required. The resource name of the selected DPC (device policy controller)
372 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
373 # call
374 # `customers.dpcs.list`.
375 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the organization. Zero-touch enrollment shows this
376 # organization name to device users during device provisioning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]377 &quot;contactEmail&quot;: &quot;A String&quot;, # Required. The email address that device users can contact to get help.
378 # Zero-touch enrollment shows this email address to device users before
379 # device provisioning. The value is validated on input.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]380 &quot;dpcExtras&quot;: &quot;A String&quot;, # The JSON-formatted EMM provisioning extras that are passed to the DPC.
381 &quot;configurationName&quot;: &quot;A String&quot;, # Required. A short name that describes the configuration&#x27;s purpose. For
382 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
383 # portal displays this name to IT admins.
384 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
385 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
386 # the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]387 &quot;isDefault&quot;: True or False, # Required. Whether this is the default configuration that zero-touch
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 # enrollment applies to any new devices the organization purchases in the
389 # future. Only one customer configuration can be the default. Setting this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]390 # value to `true`, changes the previous default configuration&#x27;s `isDefault`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]414 # enrollment works best when a customer sets a default configuration that&#x27;s
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]415 # applied to any new devices the organization purchases.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]416 &quot;customMessage&quot;: &quot;A String&quot;, # A message, containing one or two sentences, to help device users get help
417 # or give them more details about what’s happening to their device.
418 # Zero-touch enrollment shows this message before the device is provisioned.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]419 &quot;configurationId&quot;: &quot;A String&quot;, # Output only. The ID of the configuration. Assigned by the server.
420 &quot;contactPhone&quot;: &quot;A String&quot;, # Required. The telephone number that device users can call, using another
421 # device, to get help. Zero-touch enrollment shows this number to device
422 # users before device provisioning. Accepts numerals, spaces, the plus sign,
423 # hyphens, and parentheses.
424 &quot;dpcResourcePath&quot;: &quot;A String&quot;, # Required. The resource name of the selected DPC (device policy controller)
425 # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
426 # call
427 # `customers.dpcs.list`.
428 &quot;companyName&quot;: &quot;A String&quot;, # Required. The name of the organization. Zero-touch enrollment shows this
429 # organization name to device users during device provisioning.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 &quot;contactEmail&quot;: &quot;A String&quot;, # Required. The email address that device users can contact to get help.
431 # Zero-touch enrollment shows this email address to device users before
432 # device provisioning. The value is validated on input.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]433 &quot;dpcExtras&quot;: &quot;A String&quot;, # The JSON-formatted EMM provisioning extras that are passed to the DPC.
434 &quot;configurationName&quot;: &quot;A String&quot;, # Required. A short name that describes the configuration&#x27;s purpose. For
435 # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
436 # portal displays this name to IT admins.
437 &quot;name&quot;: &quot;A String&quot;, # Output only. The API resource name in the format
438 # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
439 # the server.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]440 &quot;isDefault&quot;: True or False, # Required. Whether this is the default configuration that zero-touch
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 # enrollment applies to any new devices the organization purchases in the
442 # future. Only one customer configuration can be the default. Setting this
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]443 # value to `true`, changes the previous default configuration&#x27;s `isDefault`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444 # value to `false`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]445 }</pre>
446</div>
447
448</body></html>