Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [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="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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-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 Kim | 715bd7f | 2019-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'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 94 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <pre>Creates a new configuration. Once created, a customer can apply the |
| 96 | configuration to devices. |
| 97 | |
| 98 | Args: |
| 99 | parent: string, Required. The customer that manages the configuration. An API resource name |
| 100 | in the format `customers/[CUSTOMER_ID]`. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 112 | # enrollment works best when a customer sets a default configuration that's |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 113 | # applied to any new devices the organization purchases. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | "customMessage": "A String", # 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 117 | "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For |
| 118 | # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment |
| 119 | # portal displays this name to IT admins. |
| 120 | "contactEmail": "A String", # Required. The email address that device users can contact to get help. |
| 121 | # Zero-touch enrollment shows this email address to device users before |
| 122 | # device provisioning. The value is validated on input. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 124 | # enrollment applies to any new devices the organization purchases in the |
| 125 | # future. Only one customer configuration can be the default. Setting this |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 126 | # value to `true`, changes the previous default configuration's `isDefault` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 127 | # value to `false`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 128 | "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | "name": "A String", # Output only. The API resource name in the format |
| 130 | # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by |
| 131 | # the server. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 132 | "contactPhone": "A String", # Required. The telephone number that device users can call, using another |
| 133 | # device, to get help. Zero-touch enrollment shows this number to device |
| 134 | # users before device provisioning. Accepts numerals, spaces, the plus sign, |
| 135 | # hyphens, and parentheses. |
| 136 | "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this |
| 137 | # organization name to device users during device provisioning. |
| 138 | "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller) |
| 139 | # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, |
| 140 | # call |
| 141 | # `customers.dpcs.list`. |
| 142 | "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | x__xgafv: string, V1 error format. |
| 146 | Allowed values |
| 147 | 1 - v1 error format |
| 148 | 2 - v2 error format |
| 149 | |
| 150 | Returns: |
| 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | # enrollment works best when a customer sets a default configuration that's |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 162 | # applied to any new devices the organization purchases. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 163 | "customMessage": "A String", # 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 166 | "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For |
| 167 | # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment |
| 168 | # portal displays this name to IT admins. |
| 169 | "contactEmail": "A String", # Required. The email address that device users can contact to get help. |
| 170 | # Zero-touch enrollment shows this email address to device users before |
| 171 | # device provisioning. The value is validated on input. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 173 | # enrollment applies to any new devices the organization purchases in the |
| 174 | # future. Only one customer configuration can be the default. Setting this |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | # value to `true`, changes the previous default configuration's `isDefault` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 176 | # value to `false`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 177 | "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "name": "A String", # Output only. The API resource name in the format |
| 179 | # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by |
| 180 | # the server. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 181 | "contactPhone": "A String", # Required. The telephone number that device users can call, using another |
| 182 | # device, to get help. Zero-touch enrollment shows this number to device |
| 183 | # users before device provisioning. Accepts numerals, spaces, the plus sign, |
| 184 | # hyphens, and parentheses. |
| 185 | "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this |
| 186 | # organization name to device users during device provisioning. |
| 187 | "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller) |
| 188 | # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, |
| 189 | # call |
| 190 | # `customers.dpcs.list`. |
| 191 | "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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 |
| 198 | devices with the configuration applied. |
| 199 | |
| 200 | Args: |
| 201 | name: string, Required. The configuration to delete. An API resource name in the format |
| 202 | `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the |
| 203 | configuration 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 | |
| 209 | Returns: |
| 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 | |
| 228 | Args: |
| 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 | |
| 236 | Returns: |
| 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 247 | # enrollment works best when a customer sets a default configuration that's |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 248 | # applied to any new devices the organization purchases. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 249 | "customMessage": "A String", # 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 252 | "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For |
| 253 | # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment |
| 254 | # portal displays this name to IT admins. |
| 255 | "contactEmail": "A String", # Required. The email address that device users can contact to get help. |
| 256 | # Zero-touch enrollment shows this email address to device users before |
| 257 | # device provisioning. The value is validated on input. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 258 | "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 259 | # enrollment applies to any new devices the organization purchases in the |
| 260 | # future. Only one customer configuration can be the default. Setting this |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | # value to `true`, changes the previous default configuration's `isDefault` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 262 | # value to `false`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 263 | "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 264 | "name": "A String", # Output only. The API resource name in the format |
| 265 | # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by |
| 266 | # the server. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 267 | "contactPhone": "A String", # Required. The telephone number that device users can call, using another |
| 268 | # device, to get help. Zero-touch enrollment shows this number to device |
| 269 | # users before device provisioning. Accepts numerals, spaces, the plus sign, |
| 270 | # hyphens, and parentheses. |
| 271 | "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this |
| 272 | # organization name to device users during device provisioning. |
| 273 | "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller) |
| 274 | # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, |
| 275 | # call |
| 276 | # `customers.dpcs.list`. |
| 277 | "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 278 | }</pre> |
| 279 | </div> |
| 280 | |
| 281 | <div class="method"> |
| 282 | <code class="details" id="list">list(parent, x__xgafv=None)</code> |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 283 | <pre>Lists a customer's configurations. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 284 | |
| 285 | Args: |
| 286 | parent: string, Required. The customer that manages the listed configurations. An API |
| 287 | resource 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 | |
| 293 | Returns: |
| 294 | An object of the form: |
| 295 | |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 296 | { # Response message of customer's listing configuration. |
| 297 | "configurations": [ # The configurations. |
Bu Sun Kim | 715bd7f | 2019-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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 306 | # enrollment works best when a customer sets a default configuration that's |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 307 | # applied to any new devices the organization purchases. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 308 | "customMessage": "A String", # 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 311 | "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For |
| 312 | # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment |
| 313 | # portal displays this name to IT admins. |
| 314 | "contactEmail": "A String", # Required. The email address that device users can contact to get help. |
| 315 | # Zero-touch enrollment shows this email address to device users before |
| 316 | # device provisioning. The value is validated on input. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 317 | "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 318 | # enrollment applies to any new devices the organization purchases in the |
| 319 | # future. Only one customer configuration can be the default. Setting this |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 320 | # value to `true`, changes the previous default configuration's `isDefault` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 321 | # value to `false`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 322 | "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 323 | "name": "A String", # Output only. The API resource name in the format |
| 324 | # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by |
| 325 | # the server. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 326 | "contactPhone": "A String", # Required. The telephone number that device users can call, using another |
| 327 | # device, to get help. Zero-touch enrollment shows this number to device |
| 328 | # users before device provisioning. Accepts numerals, spaces, the plus sign, |
| 329 | # hyphens, and parentheses. |
| 330 | "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this |
| 331 | # organization name to device users during device provisioning. |
| 332 | "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller) |
| 333 | # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, |
| 334 | # call |
| 335 | # `customers.dpcs.list`. |
| 336 | "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 337 | }, |
| 338 | ], |
| 339 | }</pre> |
| 340 | </div> |
| 341 | |
| 342 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 344 | <pre>Updates a configuration's field values. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 345 | |
| 346 | Args: |
| 347 | name: string, Output only. The API resource name in the format |
| 348 | `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by |
| 349 | the server. (required) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 350 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 361 | # enrollment works best when a customer sets a default configuration that's |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 362 | # applied to any new devices the organization purchases. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 363 | "customMessage": "A String", # 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 366 | "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For |
| 367 | # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment |
| 368 | # portal displays this name to IT admins. |
| 369 | "contactEmail": "A String", # Required. The email address that device users can contact to get help. |
| 370 | # Zero-touch enrollment shows this email address to device users before |
| 371 | # device provisioning. The value is validated on input. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 372 | "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 373 | # enrollment applies to any new devices the organization purchases in the |
| 374 | # future. Only one customer configuration can be the default. Setting this |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 375 | # value to `true`, changes the previous default configuration's `isDefault` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 376 | # value to `false`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 377 | "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 378 | "name": "A String", # Output only. The API resource name in the format |
| 379 | # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by |
| 380 | # the server. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 381 | "contactPhone": "A String", # Required. The telephone number that device users can call, using another |
| 382 | # device, to get help. Zero-touch enrollment shows this number to device |
| 383 | # users before device provisioning. Accepts numerals, spaces, the plus sign, |
| 384 | # hyphens, and parentheses. |
| 385 | "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this |
| 386 | # organization name to device users during device provisioning. |
| 387 | "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller) |
| 388 | # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, |
| 389 | # call |
| 390 | # `customers.dpcs.list`. |
| 391 | "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 392 | } |
| 393 | |
| 394 | updateMask: string, Required. The field mask applied to the target `Configuration` before |
| 395 | updating the fields. To learn more about using field masks, read |
| 396 | [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in |
| 397 | the Protocol Buffers documentation. |
| 398 | x__xgafv: string, V1 error format. |
| 399 | Allowed values |
| 400 | 1 - v1 error format |
| 401 | 2 - v2 error format |
| 402 | |
| 403 | Returns: |
| 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 414 | # enrollment works best when a customer sets a default configuration that's |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 415 | # applied to any new devices the organization purchases. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 416 | "customMessage": "A String", # 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 Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 419 | "configurationName": "A String", # Required. A short name that describes the configuration's purpose. For |
| 420 | # example, _Sales team_ or _Temporary employees_. The zero-touch enrollment |
| 421 | # portal displays this name to IT admins. |
| 422 | "contactEmail": "A String", # Required. The email address that device users can contact to get help. |
| 423 | # Zero-touch enrollment shows this email address to device users before |
| 424 | # device provisioning. The value is validated on input. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | "isDefault": True or False, # Required. Whether this is the default configuration that zero-touch |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 426 | # enrollment applies to any new devices the organization purchases in the |
| 427 | # future. Only one customer configuration can be the default. Setting this |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | # value to `true`, changes the previous default configuration's `isDefault` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 429 | # value to `false`. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 430 | "configurationId": "A String", # Output only. The ID of the configuration. Assigned by the server. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 431 | "name": "A String", # Output only. The API resource name in the format |
| 432 | # `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by |
| 433 | # the server. |
Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 434 | "contactPhone": "A String", # Required. The telephone number that device users can call, using another |
| 435 | # device, to get help. Zero-touch enrollment shows this number to device |
| 436 | # users before device provisioning. Accepts numerals, spaces, the plus sign, |
| 437 | # hyphens, and parentheses. |
| 438 | "companyName": "A String", # Required. The name of the organization. Zero-touch enrollment shows this |
| 439 | # organization name to device users during device provisioning. |
| 440 | "dpcResourcePath": "A String", # Required. The resource name of the selected DPC (device policy controller) |
| 441 | # in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, |
| 442 | # call |
| 443 | # `customers.dpcs.list`. |
| 444 | "dpcExtras": "A String", # The JSON-formatted EMM provisioning extras that are passed to the DPC. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 445 | }</pre> |
| 446 | </div> |
| 447 | |
| 448 | </body></html> |