| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/androidenterprise": { |
| 6 "description": "Manage corporate Android devices" |
| 7 } |
| 8 } |
| 9 } |
| 10 }, |
| 11 "basePath": "/androidenterprise/v1/", |
| 12 "baseUrl": "https://www.googleapis.com/androidenterprise/v1/", |
| 13 "batchPath": "batch", |
| 14 "canonicalName": "Android Enterprise", |
| 15 "description": "Allows MDMs/EMMs and enterprises to manage the deployment of
apps to Android for Work users.", |
| 16 "discoveryVersion": "v1", |
| 17 "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/d5u0mUacj4EqZuGQlI-jqNy-2Lg\"", |
| 18 "icons": { |
| 19 "x16": "https://www.google.com/images/icons/product/android-16.png", |
| 20 "x32": "https://www.google.com/images/icons/product/android-32.png" |
| 21 }, |
| 22 "id": "androidenterprise:v1", |
| 23 "kind": "discovery#restDescription", |
| 24 "name": "androidenterprise", |
| 25 "ownerDomain": "google.com", |
| 26 "ownerName": "Google", |
| 27 "parameters": { |
| 28 "alt": { |
| 29 "default": "json", |
| 30 "description": "Data format for the response.", |
| 31 "enum": [ |
| 32 "json" |
| 33 ], |
| 34 "enumDescriptions": [ |
| 35 "Responses with Content-Type of application/json" |
| 36 ], |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "fields": { |
| 41 "description": "Selector specifying which fields to include in a par
tial response.", |
| 42 "location": "query", |
| 43 "type": "string" |
| 44 }, |
| 45 "key": { |
| 46 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 47 "location": "query", |
| 48 "type": "string" |
| 49 }, |
| 50 "oauth_token": { |
| 51 "description": "OAuth 2.0 token for the current user.", |
| 52 "location": "query", |
| 53 "type": "string" |
| 54 }, |
| 55 "prettyPrint": { |
| 56 "default": "true", |
| 57 "description": "Returns response with indentations and line breaks."
, |
| 58 "location": "query", |
| 59 "type": "boolean" |
| 60 }, |
| 61 "quotaUser": { |
| 62 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", |
| 63 "location": "query", |
| 64 "type": "string" |
| 65 }, |
| 66 "userIp": { |
| 67 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 68 "location": "query", |
| 69 "type": "string" |
| 70 } |
| 71 }, |
| 72 "protocol": "rest", |
| 73 "resources": { |
| 74 "collections": { |
| 75 "methods": { |
| 76 "delete": { |
| 77 "description": "Deletes a collection.", |
| 78 "httpMethod": "DELETE", |
| 79 "id": "androidenterprise.collections.delete", |
| 80 "parameterOrder": [ |
| 81 "enterpriseId", |
| 82 "collectionId" |
| 83 ], |
| 84 "parameters": { |
| 85 "collectionId": { |
| 86 "description": "The ID of the collection.", |
| 87 "location": "path", |
| 88 "required": true, |
| 89 "type": "string" |
| 90 }, |
| 91 "enterpriseId": { |
| 92 "description": "The ID of the enterprise.", |
| 93 "location": "path", |
| 94 "required": true, |
| 95 "type": "string" |
| 96 } |
| 97 }, |
| 98 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}", |
| 99 "scopes": [ |
| 100 "https://www.googleapis.com/auth/androidenterprise" |
| 101 ] |
| 102 }, |
| 103 "get": { |
| 104 "description": "Retrieves the details of a collection.", |
| 105 "httpMethod": "GET", |
| 106 "id": "androidenterprise.collections.get", |
| 107 "parameterOrder": [ |
| 108 "enterpriseId", |
| 109 "collectionId" |
| 110 ], |
| 111 "parameters": { |
| 112 "collectionId": { |
| 113 "description": "The ID of the collection.", |
| 114 "location": "path", |
| 115 "required": true, |
| 116 "type": "string" |
| 117 }, |
| 118 "enterpriseId": { |
| 119 "description": "The ID of the enterprise.", |
| 120 "location": "path", |
| 121 "required": true, |
| 122 "type": "string" |
| 123 } |
| 124 }, |
| 125 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}", |
| 126 "response": { |
| 127 "$ref": "Collection" |
| 128 }, |
| 129 "scopes": [ |
| 130 "https://www.googleapis.com/auth/androidenterprise" |
| 131 ] |
| 132 }, |
| 133 "insert": { |
| 134 "description": "Creates a new collection.", |
| 135 "httpMethod": "POST", |
| 136 "id": "androidenterprise.collections.insert", |
| 137 "parameterOrder": [ |
| 138 "enterpriseId" |
| 139 ], |
| 140 "parameters": { |
| 141 "enterpriseId": { |
| 142 "description": "The ID of the enterprise.", |
| 143 "location": "path", |
| 144 "required": true, |
| 145 "type": "string" |
| 146 } |
| 147 }, |
| 148 "path": "enterprises/{enterpriseId}/collections", |
| 149 "request": { |
| 150 "$ref": "Collection" |
| 151 }, |
| 152 "response": { |
| 153 "$ref": "Collection" |
| 154 }, |
| 155 "scopes": [ |
| 156 "https://www.googleapis.com/auth/androidenterprise" |
| 157 ] |
| 158 }, |
| 159 "list": { |
| 160 "description": "Retrieves the IDs of all the collections for
an enterprise.", |
| 161 "httpMethod": "GET", |
| 162 "id": "androidenterprise.collections.list", |
| 163 "parameterOrder": [ |
| 164 "enterpriseId" |
| 165 ], |
| 166 "parameters": { |
| 167 "enterpriseId": { |
| 168 "description": "The ID of the enterprise.", |
| 169 "location": "path", |
| 170 "required": true, |
| 171 "type": "string" |
| 172 } |
| 173 }, |
| 174 "path": "enterprises/{enterpriseId}/collections", |
| 175 "response": { |
| 176 "$ref": "CollectionsListResponse" |
| 177 }, |
| 178 "scopes": [ |
| 179 "https://www.googleapis.com/auth/androidenterprise" |
| 180 ] |
| 181 }, |
| 182 "patch": { |
| 183 "description": "Updates a collection. This method supports p
atch semantics.", |
| 184 "httpMethod": "PATCH", |
| 185 "id": "androidenterprise.collections.patch", |
| 186 "parameterOrder": [ |
| 187 "enterpriseId", |
| 188 "collectionId" |
| 189 ], |
| 190 "parameters": { |
| 191 "collectionId": { |
| 192 "description": "The ID of the collection.", |
| 193 "location": "path", |
| 194 "required": true, |
| 195 "type": "string" |
| 196 }, |
| 197 "enterpriseId": { |
| 198 "description": "The ID of the enterprise.", |
| 199 "location": "path", |
| 200 "required": true, |
| 201 "type": "string" |
| 202 } |
| 203 }, |
| 204 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}", |
| 205 "request": { |
| 206 "$ref": "Collection" |
| 207 }, |
| 208 "response": { |
| 209 "$ref": "Collection" |
| 210 }, |
| 211 "scopes": [ |
| 212 "https://www.googleapis.com/auth/androidenterprise" |
| 213 ] |
| 214 }, |
| 215 "update": { |
| 216 "description": "Updates a collection.", |
| 217 "httpMethod": "PUT", |
| 218 "id": "androidenterprise.collections.update", |
| 219 "parameterOrder": [ |
| 220 "enterpriseId", |
| 221 "collectionId" |
| 222 ], |
| 223 "parameters": { |
| 224 "collectionId": { |
| 225 "description": "The ID of the collection.", |
| 226 "location": "path", |
| 227 "required": true, |
| 228 "type": "string" |
| 229 }, |
| 230 "enterpriseId": { |
| 231 "description": "The ID of the enterprise.", |
| 232 "location": "path", |
| 233 "required": true, |
| 234 "type": "string" |
| 235 } |
| 236 }, |
| 237 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}", |
| 238 "request": { |
| 239 "$ref": "Collection" |
| 240 }, |
| 241 "response": { |
| 242 "$ref": "Collection" |
| 243 }, |
| 244 "scopes": [ |
| 245 "https://www.googleapis.com/auth/androidenterprise" |
| 246 ] |
| 247 } |
| 248 } |
| 249 }, |
| 250 "collectionviewers": { |
| 251 "methods": { |
| 252 "delete": { |
| 253 "description": "Removes the user from the list of those spec
ifically allowed to see the collection. If the collection's visibility is set to
viewersOnly then only such users will see the collection.", |
| 254 "httpMethod": "DELETE", |
| 255 "id": "androidenterprise.collectionviewers.delete", |
| 256 "parameterOrder": [ |
| 257 "enterpriseId", |
| 258 "collectionId", |
| 259 "userId" |
| 260 ], |
| 261 "parameters": { |
| 262 "collectionId": { |
| 263 "description": "The ID of the collection.", |
| 264 "location": "path", |
| 265 "required": true, |
| 266 "type": "string" |
| 267 }, |
| 268 "enterpriseId": { |
| 269 "description": "The ID of the enterprise.", |
| 270 "location": "path", |
| 271 "required": true, |
| 272 "type": "string" |
| 273 }, |
| 274 "userId": { |
| 275 "description": "The ID of the user.", |
| 276 "location": "path", |
| 277 "required": true, |
| 278 "type": "string" |
| 279 } |
| 280 }, |
| 281 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}/users/{userId}", |
| 282 "scopes": [ |
| 283 "https://www.googleapis.com/auth/androidenterprise" |
| 284 ] |
| 285 }, |
| 286 "get": { |
| 287 "description": "Retrieves the ID of the user if they have be
en specifically allowed to see the collection. If the collection's visibility is
set to viewersOnly then only these users will see the collection.", |
| 288 "httpMethod": "GET", |
| 289 "id": "androidenterprise.collectionviewers.get", |
| 290 "parameterOrder": [ |
| 291 "enterpriseId", |
| 292 "collectionId", |
| 293 "userId" |
| 294 ], |
| 295 "parameters": { |
| 296 "collectionId": { |
| 297 "description": "The ID of the collection.", |
| 298 "location": "path", |
| 299 "required": true, |
| 300 "type": "string" |
| 301 }, |
| 302 "enterpriseId": { |
| 303 "description": "The ID of the enterprise.", |
| 304 "location": "path", |
| 305 "required": true, |
| 306 "type": "string" |
| 307 }, |
| 308 "userId": { |
| 309 "description": "The ID of the user.", |
| 310 "location": "path", |
| 311 "required": true, |
| 312 "type": "string" |
| 313 } |
| 314 }, |
| 315 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}/users/{userId}", |
| 316 "response": { |
| 317 "$ref": "User" |
| 318 }, |
| 319 "scopes": [ |
| 320 "https://www.googleapis.com/auth/androidenterprise" |
| 321 ] |
| 322 }, |
| 323 "list": { |
| 324 "description": "Retrieves the IDs of the users who have been
specifically allowed to see the collection. If the collection's visibility is s
et to viewersOnly then only these users will see the collection.", |
| 325 "httpMethod": "GET", |
| 326 "id": "androidenterprise.collectionviewers.list", |
| 327 "parameterOrder": [ |
| 328 "enterpriseId", |
| 329 "collectionId" |
| 330 ], |
| 331 "parameters": { |
| 332 "collectionId": { |
| 333 "description": "The ID of the collection.", |
| 334 "location": "path", |
| 335 "required": true, |
| 336 "type": "string" |
| 337 }, |
| 338 "enterpriseId": { |
| 339 "description": "The ID of the enterprise.", |
| 340 "location": "path", |
| 341 "required": true, |
| 342 "type": "string" |
| 343 } |
| 344 }, |
| 345 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}/users", |
| 346 "response": { |
| 347 "$ref": "CollectionViewersListResponse" |
| 348 }, |
| 349 "scopes": [ |
| 350 "https://www.googleapis.com/auth/androidenterprise" |
| 351 ] |
| 352 }, |
| 353 "patch": { |
| 354 "description": "Adds the user to the list of those specifica
lly allowed to see the collection. If the collection's visibility is set to view
ersOnly then only such users will see the collection. This method supports patch
semantics.", |
| 355 "httpMethod": "PATCH", |
| 356 "id": "androidenterprise.collectionviewers.patch", |
| 357 "parameterOrder": [ |
| 358 "enterpriseId", |
| 359 "collectionId", |
| 360 "userId" |
| 361 ], |
| 362 "parameters": { |
| 363 "collectionId": { |
| 364 "description": "The ID of the collection.", |
| 365 "location": "path", |
| 366 "required": true, |
| 367 "type": "string" |
| 368 }, |
| 369 "enterpriseId": { |
| 370 "description": "The ID of the enterprise.", |
| 371 "location": "path", |
| 372 "required": true, |
| 373 "type": "string" |
| 374 }, |
| 375 "userId": { |
| 376 "description": "The ID of the user.", |
| 377 "location": "path", |
| 378 "required": true, |
| 379 "type": "string" |
| 380 } |
| 381 }, |
| 382 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}/users/{userId}", |
| 383 "request": { |
| 384 "$ref": "User" |
| 385 }, |
| 386 "response": { |
| 387 "$ref": "User" |
| 388 }, |
| 389 "scopes": [ |
| 390 "https://www.googleapis.com/auth/androidenterprise" |
| 391 ] |
| 392 }, |
| 393 "update": { |
| 394 "description": "Adds the user to the list of those specifica
lly allowed to see the collection. If the collection's visibility is set to view
ersOnly then only such users will see the collection.", |
| 395 "httpMethod": "PUT", |
| 396 "id": "androidenterprise.collectionviewers.update", |
| 397 "parameterOrder": [ |
| 398 "enterpriseId", |
| 399 "collectionId", |
| 400 "userId" |
| 401 ], |
| 402 "parameters": { |
| 403 "collectionId": { |
| 404 "description": "The ID of the collection.", |
| 405 "location": "path", |
| 406 "required": true, |
| 407 "type": "string" |
| 408 }, |
| 409 "enterpriseId": { |
| 410 "description": "The ID of the enterprise.", |
| 411 "location": "path", |
| 412 "required": true, |
| 413 "type": "string" |
| 414 }, |
| 415 "userId": { |
| 416 "description": "The ID of the user.", |
| 417 "location": "path", |
| 418 "required": true, |
| 419 "type": "string" |
| 420 } |
| 421 }, |
| 422 "path": "enterprises/{enterpriseId}/collections/{collectionI
d}/users/{userId}", |
| 423 "request": { |
| 424 "$ref": "User" |
| 425 }, |
| 426 "response": { |
| 427 "$ref": "User" |
| 428 }, |
| 429 "scopes": [ |
| 430 "https://www.googleapis.com/auth/androidenterprise" |
| 431 ] |
| 432 } |
| 433 } |
| 434 }, |
| 435 "devices": { |
| 436 "methods": { |
| 437 "get": { |
| 438 "description": "Retrieves the details of a device.", |
| 439 "httpMethod": "GET", |
| 440 "id": "androidenterprise.devices.get", |
| 441 "parameterOrder": [ |
| 442 "enterpriseId", |
| 443 "userId", |
| 444 "deviceId" |
| 445 ], |
| 446 "parameters": { |
| 447 "deviceId": { |
| 448 "description": "The ID of the device.", |
| 449 "location": "path", |
| 450 "required": true, |
| 451 "type": "string" |
| 452 }, |
| 453 "enterpriseId": { |
| 454 "description": "The ID of the enterprise.", |
| 455 "location": "path", |
| 456 "required": true, |
| 457 "type": "string" |
| 458 }, |
| 459 "userId": { |
| 460 "description": "The ID of the user.", |
| 461 "location": "path", |
| 462 "required": true, |
| 463 "type": "string" |
| 464 } |
| 465 }, |
| 466 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}", |
| 467 "response": { |
| 468 "$ref": "Device" |
| 469 }, |
| 470 "scopes": [ |
| 471 "https://www.googleapis.com/auth/androidenterprise" |
| 472 ] |
| 473 }, |
| 474 "getState": { |
| 475 "description": "Retrieves whether a device is enabled or dis
abled for access by the user to Google services. The device state takes effect o
nly if enforcing EMM policies on Android devices is enabled in the Google Admin
Console. Otherwise, the device state is ignored and all devices are allowed acce
ss to Google services.", |
| 476 "httpMethod": "GET", |
| 477 "id": "androidenterprise.devices.getState", |
| 478 "parameterOrder": [ |
| 479 "enterpriseId", |
| 480 "userId", |
| 481 "deviceId" |
| 482 ], |
| 483 "parameters": { |
| 484 "deviceId": { |
| 485 "description": "The ID of the device.", |
| 486 "location": "path", |
| 487 "required": true, |
| 488 "type": "string" |
| 489 }, |
| 490 "enterpriseId": { |
| 491 "description": "The ID of the enterprise.", |
| 492 "location": "path", |
| 493 "required": true, |
| 494 "type": "string" |
| 495 }, |
| 496 "userId": { |
| 497 "description": "The ID of the user.", |
| 498 "location": "path", |
| 499 "required": true, |
| 500 "type": "string" |
| 501 } |
| 502 }, |
| 503 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/state", |
| 504 "response": { |
| 505 "$ref": "DeviceState" |
| 506 }, |
| 507 "scopes": [ |
| 508 "https://www.googleapis.com/auth/androidenterprise" |
| 509 ] |
| 510 }, |
| 511 "list": { |
| 512 "description": "Retrieves the IDs of all of a user's devices
.", |
| 513 "httpMethod": "GET", |
| 514 "id": "androidenterprise.devices.list", |
| 515 "parameterOrder": [ |
| 516 "enterpriseId", |
| 517 "userId" |
| 518 ], |
| 519 "parameters": { |
| 520 "enterpriseId": { |
| 521 "description": "The ID of the enterprise.", |
| 522 "location": "path", |
| 523 "required": true, |
| 524 "type": "string" |
| 525 }, |
| 526 "userId": { |
| 527 "description": "The ID of the user.", |
| 528 "location": "path", |
| 529 "required": true, |
| 530 "type": "string" |
| 531 } |
| 532 }, |
| 533 "path": "enterprises/{enterpriseId}/users/{userId}/devices", |
| 534 "response": { |
| 535 "$ref": "DevicesListResponse" |
| 536 }, |
| 537 "scopes": [ |
| 538 "https://www.googleapis.com/auth/androidenterprise" |
| 539 ] |
| 540 }, |
| 541 "setState": { |
| 542 "description": "Sets whether a device is enabled or disabled
for access by the user to Google services. The device state takes effect only i
f enforcing EMM policies on Android devices is enabled in the Google Admin Conso
le. Otherwise, the device state is ignored and all devices are allowed access to
Google services.", |
| 543 "httpMethod": "PUT", |
| 544 "id": "androidenterprise.devices.setState", |
| 545 "parameterOrder": [ |
| 546 "enterpriseId", |
| 547 "userId", |
| 548 "deviceId" |
| 549 ], |
| 550 "parameters": { |
| 551 "deviceId": { |
| 552 "description": "The ID of the device.", |
| 553 "location": "path", |
| 554 "required": true, |
| 555 "type": "string" |
| 556 }, |
| 557 "enterpriseId": { |
| 558 "description": "The ID of the enterprise.", |
| 559 "location": "path", |
| 560 "required": true, |
| 561 "type": "string" |
| 562 }, |
| 563 "userId": { |
| 564 "description": "The ID of the user.", |
| 565 "location": "path", |
| 566 "required": true, |
| 567 "type": "string" |
| 568 } |
| 569 }, |
| 570 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/state", |
| 571 "request": { |
| 572 "$ref": "DeviceState" |
| 573 }, |
| 574 "response": { |
| 575 "$ref": "DeviceState" |
| 576 }, |
| 577 "scopes": [ |
| 578 "https://www.googleapis.com/auth/androidenterprise" |
| 579 ] |
| 580 } |
| 581 } |
| 582 }, |
| 583 "enterprises": { |
| 584 "methods": { |
| 585 "delete": { |
| 586 "description": "Deletes the binding between the MDM and ente
rprise. This is now deprecated; use this to unenroll customers that were previou
sly enrolled with the 'insert' call, then enroll them again with the 'enroll' ca
ll.", |
| 587 "httpMethod": "DELETE", |
| 588 "id": "androidenterprise.enterprises.delete", |
| 589 "parameterOrder": [ |
| 590 "enterpriseId" |
| 591 ], |
| 592 "parameters": { |
| 593 "enterpriseId": { |
| 594 "description": "The ID of the enterprise.", |
| 595 "location": "path", |
| 596 "required": true, |
| 597 "type": "string" |
| 598 } |
| 599 }, |
| 600 "path": "enterprises/{enterpriseId}", |
| 601 "scopes": [ |
| 602 "https://www.googleapis.com/auth/androidenterprise" |
| 603 ] |
| 604 }, |
| 605 "enroll": { |
| 606 "description": "Enrolls an enterprise with the calling MDM."
, |
| 607 "httpMethod": "POST", |
| 608 "id": "androidenterprise.enterprises.enroll", |
| 609 "parameterOrder": [ |
| 610 "token" |
| 611 ], |
| 612 "parameters": { |
| 613 "token": { |
| 614 "description": "The token provided by the enterprise
to register the MDM.", |
| 615 "location": "query", |
| 616 "required": true, |
| 617 "type": "string" |
| 618 } |
| 619 }, |
| 620 "path": "enterprises/enroll", |
| 621 "request": { |
| 622 "$ref": "Enterprise" |
| 623 }, |
| 624 "response": { |
| 625 "$ref": "Enterprise" |
| 626 }, |
| 627 "scopes": [ |
| 628 "https://www.googleapis.com/auth/androidenterprise" |
| 629 ] |
| 630 }, |
| 631 "get": { |
| 632 "description": "Retrieves the name and domain of an enterpri
se.", |
| 633 "httpMethod": "GET", |
| 634 "id": "androidenterprise.enterprises.get", |
| 635 "parameterOrder": [ |
| 636 "enterpriseId" |
| 637 ], |
| 638 "parameters": { |
| 639 "enterpriseId": { |
| 640 "description": "The ID of the enterprise.", |
| 641 "location": "path", |
| 642 "required": true, |
| 643 "type": "string" |
| 644 } |
| 645 }, |
| 646 "path": "enterprises/{enterpriseId}", |
| 647 "response": { |
| 648 "$ref": "Enterprise" |
| 649 }, |
| 650 "scopes": [ |
| 651 "https://www.googleapis.com/auth/androidenterprise" |
| 652 ] |
| 653 }, |
| 654 "insert": { |
| 655 "description": "Establishes the binding between the MDM and
an enterprise. This is now deprecated; use enroll instead.", |
| 656 "httpMethod": "POST", |
| 657 "id": "androidenterprise.enterprises.insert", |
| 658 "parameterOrder": [ |
| 659 "token" |
| 660 ], |
| 661 "parameters": { |
| 662 "token": { |
| 663 "description": "The token provided by the enterprise
to register the MDM.", |
| 664 "location": "query", |
| 665 "required": true, |
| 666 "type": "string" |
| 667 } |
| 668 }, |
| 669 "path": "enterprises", |
| 670 "request": { |
| 671 "$ref": "Enterprise" |
| 672 }, |
| 673 "response": { |
| 674 "$ref": "Enterprise" |
| 675 }, |
| 676 "scopes": [ |
| 677 "https://www.googleapis.com/auth/androidenterprise" |
| 678 ] |
| 679 }, |
| 680 "list": { |
| 681 "description": "Looks up an enterprise by domain name.", |
| 682 "httpMethod": "GET", |
| 683 "id": "androidenterprise.enterprises.list", |
| 684 "parameterOrder": [ |
| 685 "domain" |
| 686 ], |
| 687 "parameters": { |
| 688 "domain": { |
| 689 "description": "The exact primary domain name of the
enterprise to look up.", |
| 690 "location": "query", |
| 691 "required": true, |
| 692 "type": "string" |
| 693 } |
| 694 }, |
| 695 "path": "enterprises", |
| 696 "response": { |
| 697 "$ref": "EnterprisesListResponse" |
| 698 }, |
| 699 "scopes": [ |
| 700 "https://www.googleapis.com/auth/androidenterprise" |
| 701 ] |
| 702 }, |
| 703 "setAccount": { |
| 704 "description": "Set the account that will be used to authent
icate to the API as the enterprise.", |
| 705 "httpMethod": "PUT", |
| 706 "id": "androidenterprise.enterprises.setAccount", |
| 707 "parameterOrder": [ |
| 708 "enterpriseId" |
| 709 ], |
| 710 "parameters": { |
| 711 "enterpriseId": { |
| 712 "description": "The ID of the enterprise.", |
| 713 "location": "path", |
| 714 "required": true, |
| 715 "type": "string" |
| 716 } |
| 717 }, |
| 718 "path": "enterprises/{enterpriseId}/account", |
| 719 "request": { |
| 720 "$ref": "EnterpriseAccount" |
| 721 }, |
| 722 "response": { |
| 723 "$ref": "EnterpriseAccount" |
| 724 }, |
| 725 "scopes": [ |
| 726 "https://www.googleapis.com/auth/androidenterprise" |
| 727 ] |
| 728 }, |
| 729 "unenroll": { |
| 730 "description": "Unenrolls an enterprise from the calling MDM
.", |
| 731 "httpMethod": "POST", |
| 732 "id": "androidenterprise.enterprises.unenroll", |
| 733 "parameterOrder": [ |
| 734 "enterpriseId" |
| 735 ], |
| 736 "parameters": { |
| 737 "enterpriseId": { |
| 738 "description": "The ID of the enterprise.", |
| 739 "location": "path", |
| 740 "required": true, |
| 741 "type": "string" |
| 742 } |
| 743 }, |
| 744 "path": "enterprises/{enterpriseId}/unenroll", |
| 745 "scopes": [ |
| 746 "https://www.googleapis.com/auth/androidenterprise" |
| 747 ] |
| 748 } |
| 749 } |
| 750 }, |
| 751 "entitlements": { |
| 752 "methods": { |
| 753 "delete": { |
| 754 "description": "Removes an entitlement to an app for a user
and uninstalls it.", |
| 755 "httpMethod": "DELETE", |
| 756 "id": "androidenterprise.entitlements.delete", |
| 757 "parameterOrder": [ |
| 758 "enterpriseId", |
| 759 "userId", |
| 760 "entitlementId" |
| 761 ], |
| 762 "parameters": { |
| 763 "enterpriseId": { |
| 764 "description": "The ID of the enterprise.", |
| 765 "location": "path", |
| 766 "required": true, |
| 767 "type": "string" |
| 768 }, |
| 769 "entitlementId": { |
| 770 "description": "The ID of the entitlement, e.g. \"ap
p:com.google.android.gm\".", |
| 771 "location": "path", |
| 772 "required": true, |
| 773 "type": "string" |
| 774 }, |
| 775 "userId": { |
| 776 "description": "The ID of the user.", |
| 777 "location": "path", |
| 778 "required": true, |
| 779 "type": "string" |
| 780 } |
| 781 }, |
| 782 "path": "enterprises/{enterpriseId}/users/{userId}/entitleme
nts/{entitlementId}", |
| 783 "scopes": [ |
| 784 "https://www.googleapis.com/auth/androidenterprise" |
| 785 ] |
| 786 }, |
| 787 "get": { |
| 788 "description": "Retrieves details of an entitlement.", |
| 789 "httpMethod": "GET", |
| 790 "id": "androidenterprise.entitlements.get", |
| 791 "parameterOrder": [ |
| 792 "enterpriseId", |
| 793 "userId", |
| 794 "entitlementId" |
| 795 ], |
| 796 "parameters": { |
| 797 "enterpriseId": { |
| 798 "description": "The ID of the enterprise.", |
| 799 "location": "path", |
| 800 "required": true, |
| 801 "type": "string" |
| 802 }, |
| 803 "entitlementId": { |
| 804 "description": "The ID of the entitlement, e.g. \"ap
p:com.google.android.gm\".", |
| 805 "location": "path", |
| 806 "required": true, |
| 807 "type": "string" |
| 808 }, |
| 809 "userId": { |
| 810 "description": "The ID of the user.", |
| 811 "location": "path", |
| 812 "required": true, |
| 813 "type": "string" |
| 814 } |
| 815 }, |
| 816 "path": "enterprises/{enterpriseId}/users/{userId}/entitleme
nts/{entitlementId}", |
| 817 "response": { |
| 818 "$ref": "Entitlement" |
| 819 }, |
| 820 "scopes": [ |
| 821 "https://www.googleapis.com/auth/androidenterprise" |
| 822 ] |
| 823 }, |
| 824 "list": { |
| 825 "description": "List of all entitlements for the specified u
ser. Only the ID is set.", |
| 826 "httpMethod": "GET", |
| 827 "id": "androidenterprise.entitlements.list", |
| 828 "parameterOrder": [ |
| 829 "enterpriseId", |
| 830 "userId" |
| 831 ], |
| 832 "parameters": { |
| 833 "enterpriseId": { |
| 834 "description": "The ID of the enterprise.", |
| 835 "location": "path", |
| 836 "required": true, |
| 837 "type": "string" |
| 838 }, |
| 839 "userId": { |
| 840 "description": "The ID of the user.", |
| 841 "location": "path", |
| 842 "required": true, |
| 843 "type": "string" |
| 844 } |
| 845 }, |
| 846 "path": "enterprises/{enterpriseId}/users/{userId}/entitleme
nts", |
| 847 "response": { |
| 848 "$ref": "EntitlementsListResponse" |
| 849 }, |
| 850 "scopes": [ |
| 851 "https://www.googleapis.com/auth/androidenterprise" |
| 852 ] |
| 853 }, |
| 854 "patch": { |
| 855 "description": "Adds or updates an entitlement to an app for
a user. This method supports patch semantics.", |
| 856 "httpMethod": "PATCH", |
| 857 "id": "androidenterprise.entitlements.patch", |
| 858 "parameterOrder": [ |
| 859 "enterpriseId", |
| 860 "userId", |
| 861 "entitlementId" |
| 862 ], |
| 863 "parameters": { |
| 864 "enterpriseId": { |
| 865 "description": "The ID of the enterprise.", |
| 866 "location": "path", |
| 867 "required": true, |
| 868 "type": "string" |
| 869 }, |
| 870 "entitlementId": { |
| 871 "description": "The ID of the entitlement, e.g. \"ap
p:com.google.android.gm\".", |
| 872 "location": "path", |
| 873 "required": true, |
| 874 "type": "string" |
| 875 }, |
| 876 "install": { |
| 877 "description": "Set to true to also install the prod
uct on all the user's devices where possible. Failure to install on one or more
devices will not prevent this operation from returning successfully, as long as
the entitlement was successfully assigned to the user.", |
| 878 "location": "query", |
| 879 "type": "boolean" |
| 880 }, |
| 881 "userId": { |
| 882 "description": "The ID of the user.", |
| 883 "location": "path", |
| 884 "required": true, |
| 885 "type": "string" |
| 886 } |
| 887 }, |
| 888 "path": "enterprises/{enterpriseId}/users/{userId}/entitleme
nts/{entitlementId}", |
| 889 "request": { |
| 890 "$ref": "Entitlement" |
| 891 }, |
| 892 "response": { |
| 893 "$ref": "Entitlement" |
| 894 }, |
| 895 "scopes": [ |
| 896 "https://www.googleapis.com/auth/androidenterprise" |
| 897 ] |
| 898 }, |
| 899 "update": { |
| 900 "description": "Adds or updates an entitlement to an app for
a user.", |
| 901 "httpMethod": "PUT", |
| 902 "id": "androidenterprise.entitlements.update", |
| 903 "parameterOrder": [ |
| 904 "enterpriseId", |
| 905 "userId", |
| 906 "entitlementId" |
| 907 ], |
| 908 "parameters": { |
| 909 "enterpriseId": { |
| 910 "description": "The ID of the enterprise.", |
| 911 "location": "path", |
| 912 "required": true, |
| 913 "type": "string" |
| 914 }, |
| 915 "entitlementId": { |
| 916 "description": "The ID of the entitlement, e.g. \"ap
p:com.google.android.gm\".", |
| 917 "location": "path", |
| 918 "required": true, |
| 919 "type": "string" |
| 920 }, |
| 921 "install": { |
| 922 "description": "Set to true to also install the prod
uct on all the user's devices where possible. Failure to install on one or more
devices will not prevent this operation from returning successfully, as long as
the entitlement was successfully assigned to the user.", |
| 923 "location": "query", |
| 924 "type": "boolean" |
| 925 }, |
| 926 "userId": { |
| 927 "description": "The ID of the user.", |
| 928 "location": "path", |
| 929 "required": true, |
| 930 "type": "string" |
| 931 } |
| 932 }, |
| 933 "path": "enterprises/{enterpriseId}/users/{userId}/entitleme
nts/{entitlementId}", |
| 934 "request": { |
| 935 "$ref": "Entitlement" |
| 936 }, |
| 937 "response": { |
| 938 "$ref": "Entitlement" |
| 939 }, |
| 940 "scopes": [ |
| 941 "https://www.googleapis.com/auth/androidenterprise" |
| 942 ] |
| 943 } |
| 944 } |
| 945 }, |
| 946 "grouplicenses": { |
| 947 "methods": { |
| 948 "get": { |
| 949 "description": "Retrieves details of an enterprise's group l
icense for a product.", |
| 950 "httpMethod": "GET", |
| 951 "id": "androidenterprise.grouplicenses.get", |
| 952 "parameterOrder": [ |
| 953 "enterpriseId", |
| 954 "groupLicenseId" |
| 955 ], |
| 956 "parameters": { |
| 957 "enterpriseId": { |
| 958 "description": "The ID of the enterprise.", |
| 959 "location": "path", |
| 960 "required": true, |
| 961 "type": "string" |
| 962 }, |
| 963 "groupLicenseId": { |
| 964 "description": "The ID of the product the group lice
nse is for, e.g. \"app:com.google.android.gm\".", |
| 965 "location": "path", |
| 966 "required": true, |
| 967 "type": "string" |
| 968 } |
| 969 }, |
| 970 "path": "enterprises/{enterpriseId}/groupLicenses/{groupLice
nseId}", |
| 971 "response": { |
| 972 "$ref": "GroupLicense" |
| 973 }, |
| 974 "scopes": [ |
| 975 "https://www.googleapis.com/auth/androidenterprise" |
| 976 ] |
| 977 }, |
| 978 "list": { |
| 979 "description": "Retrieves IDs of all products for which the
enterprise has a group license.", |
| 980 "httpMethod": "GET", |
| 981 "id": "androidenterprise.grouplicenses.list", |
| 982 "parameterOrder": [ |
| 983 "enterpriseId" |
| 984 ], |
| 985 "parameters": { |
| 986 "enterpriseId": { |
| 987 "description": "The ID of the enterprise.", |
| 988 "location": "path", |
| 989 "required": true, |
| 990 "type": "string" |
| 991 } |
| 992 }, |
| 993 "path": "enterprises/{enterpriseId}/groupLicenses", |
| 994 "response": { |
| 995 "$ref": "GroupLicensesListResponse" |
| 996 }, |
| 997 "scopes": [ |
| 998 "https://www.googleapis.com/auth/androidenterprise" |
| 999 ] |
| 1000 } |
| 1001 } |
| 1002 }, |
| 1003 "grouplicenseusers": { |
| 1004 "methods": { |
| 1005 "list": { |
| 1006 "description": "Retrieves the IDs of the users who have been
granted entitlements under the license.", |
| 1007 "httpMethod": "GET", |
| 1008 "id": "androidenterprise.grouplicenseusers.list", |
| 1009 "parameterOrder": [ |
| 1010 "enterpriseId", |
| 1011 "groupLicenseId" |
| 1012 ], |
| 1013 "parameters": { |
| 1014 "enterpriseId": { |
| 1015 "description": "The ID of the enterprise.", |
| 1016 "location": "path", |
| 1017 "required": true, |
| 1018 "type": "string" |
| 1019 }, |
| 1020 "groupLicenseId": { |
| 1021 "description": "The ID of the product the group lice
nse is for, e.g. \"app:com.google.android.gm\".", |
| 1022 "location": "path", |
| 1023 "required": true, |
| 1024 "type": "string" |
| 1025 } |
| 1026 }, |
| 1027 "path": "enterprises/{enterpriseId}/groupLicenses/{groupLice
nseId}/users", |
| 1028 "response": { |
| 1029 "$ref": "GroupLicenseUsersListResponse" |
| 1030 }, |
| 1031 "scopes": [ |
| 1032 "https://www.googleapis.com/auth/androidenterprise" |
| 1033 ] |
| 1034 } |
| 1035 } |
| 1036 }, |
| 1037 "installs": { |
| 1038 "methods": { |
| 1039 "delete": { |
| 1040 "description": "Requests to remove an app from a device. A c
all to get or list will still show the app as installed on the device until it i
s actually removed.", |
| 1041 "httpMethod": "DELETE", |
| 1042 "id": "androidenterprise.installs.delete", |
| 1043 "parameterOrder": [ |
| 1044 "enterpriseId", |
| 1045 "userId", |
| 1046 "deviceId", |
| 1047 "installId" |
| 1048 ], |
| 1049 "parameters": { |
| 1050 "deviceId": { |
| 1051 "description": "The Android ID of the device.", |
| 1052 "location": "path", |
| 1053 "required": true, |
| 1054 "type": "string" |
| 1055 }, |
| 1056 "enterpriseId": { |
| 1057 "description": "The ID of the enterprise.", |
| 1058 "location": "path", |
| 1059 "required": true, |
| 1060 "type": "string" |
| 1061 }, |
| 1062 "installId": { |
| 1063 "description": "The ID of the product represented by
the install, e.g. \"app:com.google.android.gm\".", |
| 1064 "location": "path", |
| 1065 "required": true, |
| 1066 "type": "string" |
| 1067 }, |
| 1068 "userId": { |
| 1069 "description": "The ID of the user.", |
| 1070 "location": "path", |
| 1071 "required": true, |
| 1072 "type": "string" |
| 1073 } |
| 1074 }, |
| 1075 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/installs/{installId}", |
| 1076 "scopes": [ |
| 1077 "https://www.googleapis.com/auth/androidenterprise" |
| 1078 ] |
| 1079 }, |
| 1080 "get": { |
| 1081 "description": "Retrieves details of an installation of an a
pp on a device.", |
| 1082 "httpMethod": "GET", |
| 1083 "id": "androidenterprise.installs.get", |
| 1084 "parameterOrder": [ |
| 1085 "enterpriseId", |
| 1086 "userId", |
| 1087 "deviceId", |
| 1088 "installId" |
| 1089 ], |
| 1090 "parameters": { |
| 1091 "deviceId": { |
| 1092 "description": "The Android ID of the device.", |
| 1093 "location": "path", |
| 1094 "required": true, |
| 1095 "type": "string" |
| 1096 }, |
| 1097 "enterpriseId": { |
| 1098 "description": "The ID of the enterprise.", |
| 1099 "location": "path", |
| 1100 "required": true, |
| 1101 "type": "string" |
| 1102 }, |
| 1103 "installId": { |
| 1104 "description": "The ID of the product represented by
the install, e.g. \"app:com.google.android.gm\".", |
| 1105 "location": "path", |
| 1106 "required": true, |
| 1107 "type": "string" |
| 1108 }, |
| 1109 "userId": { |
| 1110 "description": "The ID of the user.", |
| 1111 "location": "path", |
| 1112 "required": true, |
| 1113 "type": "string" |
| 1114 } |
| 1115 }, |
| 1116 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/installs/{installId}", |
| 1117 "response": { |
| 1118 "$ref": "Install" |
| 1119 }, |
| 1120 "scopes": [ |
| 1121 "https://www.googleapis.com/auth/androidenterprise" |
| 1122 ] |
| 1123 }, |
| 1124 "list": { |
| 1125 "description": "Retrieves the details of all apps installed
on the specified device.", |
| 1126 "httpMethod": "GET", |
| 1127 "id": "androidenterprise.installs.list", |
| 1128 "parameterOrder": [ |
| 1129 "enterpriseId", |
| 1130 "userId", |
| 1131 "deviceId" |
| 1132 ], |
| 1133 "parameters": { |
| 1134 "deviceId": { |
| 1135 "description": "The Android ID of the device.", |
| 1136 "location": "path", |
| 1137 "required": true, |
| 1138 "type": "string" |
| 1139 }, |
| 1140 "enterpriseId": { |
| 1141 "description": "The ID of the enterprise.", |
| 1142 "location": "path", |
| 1143 "required": true, |
| 1144 "type": "string" |
| 1145 }, |
| 1146 "userId": { |
| 1147 "description": "The ID of the user.", |
| 1148 "location": "path", |
| 1149 "required": true, |
| 1150 "type": "string" |
| 1151 } |
| 1152 }, |
| 1153 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/installs", |
| 1154 "response": { |
| 1155 "$ref": "InstallsListResponse" |
| 1156 }, |
| 1157 "scopes": [ |
| 1158 "https://www.googleapis.com/auth/androidenterprise" |
| 1159 ] |
| 1160 }, |
| 1161 "patch": { |
| 1162 "description": "Requests to install the latest version of an
app to a device. If the app is already installed then it is updated to the late
st version if necessary. This method supports patch semantics.", |
| 1163 "httpMethod": "PATCH", |
| 1164 "id": "androidenterprise.installs.patch", |
| 1165 "parameterOrder": [ |
| 1166 "enterpriseId", |
| 1167 "userId", |
| 1168 "deviceId", |
| 1169 "installId" |
| 1170 ], |
| 1171 "parameters": { |
| 1172 "deviceId": { |
| 1173 "description": "The Android ID of the device.", |
| 1174 "location": "path", |
| 1175 "required": true, |
| 1176 "type": "string" |
| 1177 }, |
| 1178 "enterpriseId": { |
| 1179 "description": "The ID of the enterprise.", |
| 1180 "location": "path", |
| 1181 "required": true, |
| 1182 "type": "string" |
| 1183 }, |
| 1184 "installId": { |
| 1185 "description": "The ID of the product represented by
the install, e.g. \"app:com.google.android.gm\".", |
| 1186 "location": "path", |
| 1187 "required": true, |
| 1188 "type": "string" |
| 1189 }, |
| 1190 "userId": { |
| 1191 "description": "The ID of the user.", |
| 1192 "location": "path", |
| 1193 "required": true, |
| 1194 "type": "string" |
| 1195 } |
| 1196 }, |
| 1197 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/installs/{installId}", |
| 1198 "request": { |
| 1199 "$ref": "Install" |
| 1200 }, |
| 1201 "response": { |
| 1202 "$ref": "Install" |
| 1203 }, |
| 1204 "scopes": [ |
| 1205 "https://www.googleapis.com/auth/androidenterprise" |
| 1206 ] |
| 1207 }, |
| 1208 "update": { |
| 1209 "description": "Requests to install the latest version of an
app to a device. If the app is already installed then it is updated to the late
st version if necessary.", |
| 1210 "httpMethod": "PUT", |
| 1211 "id": "androidenterprise.installs.update", |
| 1212 "parameterOrder": [ |
| 1213 "enterpriseId", |
| 1214 "userId", |
| 1215 "deviceId", |
| 1216 "installId" |
| 1217 ], |
| 1218 "parameters": { |
| 1219 "deviceId": { |
| 1220 "description": "The Android ID of the device.", |
| 1221 "location": "path", |
| 1222 "required": true, |
| 1223 "type": "string" |
| 1224 }, |
| 1225 "enterpriseId": { |
| 1226 "description": "The ID of the enterprise.", |
| 1227 "location": "path", |
| 1228 "required": true, |
| 1229 "type": "string" |
| 1230 }, |
| 1231 "installId": { |
| 1232 "description": "The ID of the product represented by
the install, e.g. \"app:com.google.android.gm\".", |
| 1233 "location": "path", |
| 1234 "required": true, |
| 1235 "type": "string" |
| 1236 }, |
| 1237 "userId": { |
| 1238 "description": "The ID of the user.", |
| 1239 "location": "path", |
| 1240 "required": true, |
| 1241 "type": "string" |
| 1242 } |
| 1243 }, |
| 1244 "path": "enterprises/{enterpriseId}/users/{userId}/devices/{
deviceId}/installs/{installId}", |
| 1245 "request": { |
| 1246 "$ref": "Install" |
| 1247 }, |
| 1248 "response": { |
| 1249 "$ref": "Install" |
| 1250 }, |
| 1251 "scopes": [ |
| 1252 "https://www.googleapis.com/auth/androidenterprise" |
| 1253 ] |
| 1254 } |
| 1255 } |
| 1256 }, |
| 1257 "permissions": { |
| 1258 "methods": { |
| 1259 "get": { |
| 1260 "description": "Retrieves details of an Android app permissi
on for display to an enterprise admin.", |
| 1261 "httpMethod": "GET", |
| 1262 "id": "androidenterprise.permissions.get", |
| 1263 "parameterOrder": [ |
| 1264 "permissionId" |
| 1265 ], |
| 1266 "parameters": { |
| 1267 "language": { |
| 1268 "description": "The BCP47 tag for the user's preferr
ed language (e.g. \"en-US\", \"de\")", |
| 1269 "location": "query", |
| 1270 "type": "string" |
| 1271 }, |
| 1272 "permissionId": { |
| 1273 "description": "The ID of the permission.", |
| 1274 "location": "path", |
| 1275 "required": true, |
| 1276 "type": "string" |
| 1277 } |
| 1278 }, |
| 1279 "path": "permissions/{permissionId}", |
| 1280 "response": { |
| 1281 "$ref": "Permission" |
| 1282 }, |
| 1283 "scopes": [ |
| 1284 "https://www.googleapis.com/auth/androidenterprise" |
| 1285 ] |
| 1286 } |
| 1287 } |
| 1288 }, |
| 1289 "products": { |
| 1290 "methods": { |
| 1291 "get": { |
| 1292 "description": "Retrieves details of a product for display t
o an enterprise admin.", |
| 1293 "httpMethod": "GET", |
| 1294 "id": "androidenterprise.products.get", |
| 1295 "parameterOrder": [ |
| 1296 "enterpriseId", |
| 1297 "productId" |
| 1298 ], |
| 1299 "parameters": { |
| 1300 "enterpriseId": { |
| 1301 "description": "The ID of the enterprise.", |
| 1302 "location": "path", |
| 1303 "required": true, |
| 1304 "type": "string" |
| 1305 }, |
| 1306 "language": { |
| 1307 "description": "The BCP47 tag for the user's preferr
ed language (e.g. \"en-US\", \"de\").", |
| 1308 "location": "query", |
| 1309 "type": "string" |
| 1310 }, |
| 1311 "productId": { |
| 1312 "description": "The ID of the product, e.g. \"app:co
m.google.android.gm\".", |
| 1313 "location": "path", |
| 1314 "required": true, |
| 1315 "type": "string" |
| 1316 } |
| 1317 }, |
| 1318 "path": "enterprises/{enterpriseId}/products/{productId}", |
| 1319 "response": { |
| 1320 "$ref": "Product" |
| 1321 }, |
| 1322 "scopes": [ |
| 1323 "https://www.googleapis.com/auth/androidenterprise" |
| 1324 ] |
| 1325 }, |
| 1326 "getAppRestrictionsSchema": { |
| 1327 "description": "Retrieves the schema defining app restrictio
ns configurable for this product. All products have a schema, but this may be em
pty if no app restrictions are defined.", |
| 1328 "httpMethod": "GET", |
| 1329 "id": "androidenterprise.products.getAppRestrictionsSchema", |
| 1330 "parameterOrder": [ |
| 1331 "enterpriseId", |
| 1332 "productId" |
| 1333 ], |
| 1334 "parameters": { |
| 1335 "enterpriseId": { |
| 1336 "description": "The ID of the enterprise.", |
| 1337 "location": "path", |
| 1338 "required": true, |
| 1339 "type": "string" |
| 1340 }, |
| 1341 "language": { |
| 1342 "description": "The BCP47 tag for the user's preferr
ed language (e.g. \"en-US\", \"de\").", |
| 1343 "location": "query", |
| 1344 "type": "string" |
| 1345 }, |
| 1346 "productId": { |
| 1347 "description": "The ID of the product.", |
| 1348 "location": "path", |
| 1349 "required": true, |
| 1350 "type": "string" |
| 1351 } |
| 1352 }, |
| 1353 "path": "enterprises/{enterpriseId}/products/{productId}/app
RestrictionsSchema", |
| 1354 "response": { |
| 1355 "$ref": "AppRestrictionsSchema" |
| 1356 }, |
| 1357 "scopes": [ |
| 1358 "https://www.googleapis.com/auth/androidenterprise" |
| 1359 ] |
| 1360 }, |
| 1361 "getPermissions": { |
| 1362 "description": "Retrieves the Android app permissions requir
ed by this app.", |
| 1363 "httpMethod": "GET", |
| 1364 "id": "androidenterprise.products.getPermissions", |
| 1365 "parameterOrder": [ |
| 1366 "enterpriseId", |
| 1367 "productId" |
| 1368 ], |
| 1369 "parameters": { |
| 1370 "enterpriseId": { |
| 1371 "description": "The ID of the enterprise.", |
| 1372 "location": "path", |
| 1373 "required": true, |
| 1374 "type": "string" |
| 1375 }, |
| 1376 "productId": { |
| 1377 "description": "The ID of the product.", |
| 1378 "location": "path", |
| 1379 "required": true, |
| 1380 "type": "string" |
| 1381 } |
| 1382 }, |
| 1383 "path": "enterprises/{enterpriseId}/products/{productId}/per
missions", |
| 1384 "response": { |
| 1385 "$ref": "ProductPermissions" |
| 1386 }, |
| 1387 "scopes": [ |
| 1388 "https://www.googleapis.com/auth/androidenterprise" |
| 1389 ] |
| 1390 }, |
| 1391 "updatePermissions": { |
| 1392 "description": "Updates the set of Android app permissions f
or this app that have been accepted by the enterprise.", |
| 1393 "httpMethod": "PUT", |
| 1394 "id": "androidenterprise.products.updatePermissions", |
| 1395 "parameterOrder": [ |
| 1396 "enterpriseId", |
| 1397 "productId" |
| 1398 ], |
| 1399 "parameters": { |
| 1400 "enterpriseId": { |
| 1401 "description": "The ID of the enterprise.", |
| 1402 "location": "path", |
| 1403 "required": true, |
| 1404 "type": "string" |
| 1405 }, |
| 1406 "productId": { |
| 1407 "description": "The ID of the product.", |
| 1408 "location": "path", |
| 1409 "required": true, |
| 1410 "type": "string" |
| 1411 } |
| 1412 }, |
| 1413 "path": "enterprises/{enterpriseId}/products/{productId}/per
missions", |
| 1414 "request": { |
| 1415 "$ref": "ProductPermissions" |
| 1416 }, |
| 1417 "response": { |
| 1418 "$ref": "ProductPermissions" |
| 1419 }, |
| 1420 "scopes": [ |
| 1421 "https://www.googleapis.com/auth/androidenterprise" |
| 1422 ] |
| 1423 } |
| 1424 } |
| 1425 }, |
| 1426 "users": { |
| 1427 "methods": { |
| 1428 "generateToken": { |
| 1429 "description": "Generates a token (activation code) to allow
this user to configure their work account in the Android Setup Wizard. Revokes
any previously generated token.", |
| 1430 "httpMethod": "POST", |
| 1431 "id": "androidenterprise.users.generateToken", |
| 1432 "parameterOrder": [ |
| 1433 "enterpriseId", |
| 1434 "userId" |
| 1435 ], |
| 1436 "parameters": { |
| 1437 "enterpriseId": { |
| 1438 "description": "The ID of the enterprise.", |
| 1439 "location": "path", |
| 1440 "required": true, |
| 1441 "type": "string" |
| 1442 }, |
| 1443 "userId": { |
| 1444 "description": "The ID of the user.", |
| 1445 "location": "path", |
| 1446 "required": true, |
| 1447 "type": "string" |
| 1448 } |
| 1449 }, |
| 1450 "path": "enterprises/{enterpriseId}/users/{userId}/token", |
| 1451 "response": { |
| 1452 "$ref": "UserToken" |
| 1453 }, |
| 1454 "scopes": [ |
| 1455 "https://www.googleapis.com/auth/androidenterprise" |
| 1456 ] |
| 1457 }, |
| 1458 "get": { |
| 1459 "description": "Retrieves a user's details.", |
| 1460 "httpMethod": "GET", |
| 1461 "id": "androidenterprise.users.get", |
| 1462 "parameterOrder": [ |
| 1463 "enterpriseId", |
| 1464 "userId" |
| 1465 ], |
| 1466 "parameters": { |
| 1467 "enterpriseId": { |
| 1468 "description": "The ID of the enterprise.", |
| 1469 "location": "path", |
| 1470 "required": true, |
| 1471 "type": "string" |
| 1472 }, |
| 1473 "userId": { |
| 1474 "description": "The ID of the user.", |
| 1475 "location": "path", |
| 1476 "required": true, |
| 1477 "type": "string" |
| 1478 } |
| 1479 }, |
| 1480 "path": "enterprises/{enterpriseId}/users/{userId}", |
| 1481 "response": { |
| 1482 "$ref": "User" |
| 1483 }, |
| 1484 "scopes": [ |
| 1485 "https://www.googleapis.com/auth/androidenterprise" |
| 1486 ] |
| 1487 }, |
| 1488 "list": { |
| 1489 "description": "Looks up a user by email address.", |
| 1490 "httpMethod": "GET", |
| 1491 "id": "androidenterprise.users.list", |
| 1492 "parameterOrder": [ |
| 1493 "enterpriseId", |
| 1494 "email" |
| 1495 ], |
| 1496 "parameters": { |
| 1497 "email": { |
| 1498 "description": "The exact primary email address of t
he user to look up.", |
| 1499 "location": "query", |
| 1500 "required": true, |
| 1501 "type": "string" |
| 1502 }, |
| 1503 "enterpriseId": { |
| 1504 "description": "The ID of the enterprise.", |
| 1505 "location": "path", |
| 1506 "required": true, |
| 1507 "type": "string" |
| 1508 } |
| 1509 }, |
| 1510 "path": "enterprises/{enterpriseId}/users", |
| 1511 "response": { |
| 1512 "$ref": "UsersListResponse" |
| 1513 }, |
| 1514 "scopes": [ |
| 1515 "https://www.googleapis.com/auth/androidenterprise" |
| 1516 ] |
| 1517 }, |
| 1518 "revokeToken": { |
| 1519 "description": "Revokes a previously generated token (activa
tion code) for the user.", |
| 1520 "httpMethod": "DELETE", |
| 1521 "id": "androidenterprise.users.revokeToken", |
| 1522 "parameterOrder": [ |
| 1523 "enterpriseId", |
| 1524 "userId" |
| 1525 ], |
| 1526 "parameters": { |
| 1527 "enterpriseId": { |
| 1528 "description": "The ID of the enterprise.", |
| 1529 "location": "path", |
| 1530 "required": true, |
| 1531 "type": "string" |
| 1532 }, |
| 1533 "userId": { |
| 1534 "description": "The ID of the user.", |
| 1535 "location": "path", |
| 1536 "required": true, |
| 1537 "type": "string" |
| 1538 } |
| 1539 }, |
| 1540 "path": "enterprises/{enterpriseId}/users/{userId}/token", |
| 1541 "scopes": [ |
| 1542 "https://www.googleapis.com/auth/androidenterprise" |
| 1543 ] |
| 1544 } |
| 1545 } |
| 1546 } |
| 1547 }, |
| 1548 "revision": "20150309", |
| 1549 "rootUrl": "https://www.googleapis.com/", |
| 1550 "schemas": { |
| 1551 "AppRestrictionsSchema": { |
| 1552 "description": "Represents the list of app restrictions available to
be pre-configured for the product.", |
| 1553 "id": "AppRestrictionsSchema", |
| 1554 "properties": { |
| 1555 "restrictions": { |
| 1556 "description": "The set of restrictions that make up this sc
hema.", |
| 1557 "items": { |
| 1558 "$ref": "AppRestrictionsSchemaRestriction" |
| 1559 }, |
| 1560 "type": "array" |
| 1561 } |
| 1562 }, |
| 1563 "type": "object" |
| 1564 }, |
| 1565 "AppRestrictionsSchemaRestriction": { |
| 1566 "description": "A restriction in the App Restriction Schema represen
ts a piece of configuration that may be pre-applied.", |
| 1567 "id": "AppRestrictionsSchemaRestriction", |
| 1568 "properties": { |
| 1569 "defaultValue": { |
| 1570 "$ref": "AppRestrictionsSchemaRestrictionRestrictionValue", |
| 1571 "description": "The default value of the restriction." |
| 1572 }, |
| 1573 "description": { |
| 1574 "description": "A longer description of the restriction, giv
ing more detail of what it affects.", |
| 1575 "type": "string" |
| 1576 }, |
| 1577 "entry": { |
| 1578 "description": "For choice or multiselect restrictions, the
list of possible entries' human-readable names.", |
| 1579 "items": { |
| 1580 "type": "string" |
| 1581 }, |
| 1582 "type": "array" |
| 1583 }, |
| 1584 "entryValue": { |
| 1585 "description": "For choice or multiselect restrictions, the
list of possible entries' machine-readable values.", |
| 1586 "items": { |
| 1587 "type": "string" |
| 1588 }, |
| 1589 "type": "array" |
| 1590 }, |
| 1591 "key": { |
| 1592 "description": "The unique key that the product uses to iden
tify the restriction, e.g. \"com.google.android.gm.fieldname\".", |
| 1593 "type": "string" |
| 1594 }, |
| 1595 "restrictionType": { |
| 1596 "description": "The type of the restriction.", |
| 1597 "type": "string" |
| 1598 }, |
| 1599 "title": { |
| 1600 "description": "The name of the restriction.", |
| 1601 "type": "string" |
| 1602 } |
| 1603 }, |
| 1604 "type": "object" |
| 1605 }, |
| 1606 "AppRestrictionsSchemaRestrictionRestrictionValue": { |
| 1607 "description": "A typed value for the restriction.", |
| 1608 "id": "AppRestrictionsSchemaRestrictionRestrictionValue", |
| 1609 "properties": { |
| 1610 "type": { |
| 1611 "description": "The type of the value being provided.", |
| 1612 "type": "string" |
| 1613 }, |
| 1614 "valueBool": { |
| 1615 "description": "The boolean value - this will only be presen
t if type is bool.", |
| 1616 "type": "boolean" |
| 1617 }, |
| 1618 "valueInteger": { |
| 1619 "description": "The integer value - this will only be presen
t if type is integer.", |
| 1620 "format": "int32", |
| 1621 "type": "integer" |
| 1622 }, |
| 1623 "valueMultiselect": { |
| 1624 "description": "The list of string values - this will only b
e present if type is multiselect.", |
| 1625 "items": { |
| 1626 "type": "string" |
| 1627 }, |
| 1628 "type": "array" |
| 1629 }, |
| 1630 "valueString": { |
| 1631 "description": "The string value - this will be present for
types string, choice and hidden.", |
| 1632 "type": "string" |
| 1633 } |
| 1634 }, |
| 1635 "type": "object" |
| 1636 }, |
| 1637 "Collection": { |
| 1638 "description": "A collection resource defines a named set of apps th
at is visible to a set of users in the Google Play Store app running on those us
ers' managed devices. Those users can then install any of those apps if they wis
h (which will trigger creation of install and entitlement resources). A user can
not install an app on a managed device unless the app is listed in at least one
collection that is visible to that user.\n\nNote that the API can be used to dir
ectly install an app regardless of whether it is in any collection - so an enter
prise has a choice of either directly pushing apps to users, or allowing users t
o install apps if they want. Which is appropriate will depend on the enterprise'
s policies and the purpose of the apps concerned.", |
| 1639 "id": "Collection", |
| 1640 "properties": { |
| 1641 "collectionId": { |
| 1642 "description": "Arbitrary unique ID, allocated by the API on
creation.", |
| 1643 "type": "string" |
| 1644 }, |
| 1645 "kind": { |
| 1646 "default": "androidenterprise#collection", |
| 1647 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#collection\".", |
| 1648 "type": "string" |
| 1649 }, |
| 1650 "name": { |
| 1651 "annotations": { |
| 1652 "required": [ |
| 1653 "androidenterprise.collections.insert", |
| 1654 "androidenterprise.collections.update" |
| 1655 ] |
| 1656 }, |
| 1657 "description": "A user-friendly name for the collection (sho
uld be unique), e.g. \"Accounting apps\".", |
| 1658 "type": "string" |
| 1659 }, |
| 1660 "productId": { |
| 1661 "annotations": { |
| 1662 "required": [ |
| 1663 "androidenterprise.collections.insert", |
| 1664 "androidenterprise.collections.update" |
| 1665 ] |
| 1666 }, |
| 1667 "description": "The IDs of the products in the collection, i
n the order in which they should be displayed.", |
| 1668 "items": { |
| 1669 "type": "string" |
| 1670 }, |
| 1671 "type": "array" |
| 1672 }, |
| 1673 "visibility": { |
| 1674 "description": "Whether this collection is visible to all us
ers, or only to the users that have been granted access through the collection_v
iewers api. Even if a collection is visible to allUsers, it is possible to add a
nd remove viewers, but this will have no effect until the collection's visibilit
y changes to viewersOnly.", |
| 1675 "type": "string" |
| 1676 } |
| 1677 }, |
| 1678 "type": "object" |
| 1679 }, |
| 1680 "CollectionViewersListResponse": { |
| 1681 "description": "The user resources for the collection.", |
| 1682 "id": "CollectionViewersListResponse", |
| 1683 "properties": { |
| 1684 "kind": { |
| 1685 "default": "androidenterprise#collectionViewersListResponse"
, |
| 1686 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#collectionViewersListResponse\".", |
| 1687 "type": "string" |
| 1688 }, |
| 1689 "user": { |
| 1690 "description": "A user of an enterprise.", |
| 1691 "items": { |
| 1692 "$ref": "User" |
| 1693 }, |
| 1694 "type": "array" |
| 1695 } |
| 1696 }, |
| 1697 "type": "object" |
| 1698 }, |
| 1699 "CollectionsListResponse": { |
| 1700 "description": "The collection resources for the enterprise.", |
| 1701 "id": "CollectionsListResponse", |
| 1702 "properties": { |
| 1703 "collection": { |
| 1704 "description": "An ordered collection of products which can
be made visible on the Google Play Store app to a selected group of users.", |
| 1705 "items": { |
| 1706 "$ref": "Collection" |
| 1707 }, |
| 1708 "type": "array" |
| 1709 }, |
| 1710 "kind": { |
| 1711 "default": "androidenterprise#collectionsListResponse", |
| 1712 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#collectionsListResponse\".", |
| 1713 "type": "string" |
| 1714 } |
| 1715 }, |
| 1716 "type": "object" |
| 1717 }, |
| 1718 "Device": { |
| 1719 "description": "A device resource represents a mobile device managed
by the MDM and belonging to a specific enterprise user.\n\nThis collection cann
ot be modified via the API; it is automatically populated as devices are set up
to be managed.", |
| 1720 "id": "Device", |
| 1721 "properties": { |
| 1722 "androidId": { |
| 1723 "description": "The Google Play Services Android ID for the
device encoded as a lowercase hex string, e.g. \"123456789abcdef0\".", |
| 1724 "type": "string" |
| 1725 }, |
| 1726 "kind": { |
| 1727 "default": "androidenterprise#device", |
| 1728 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#device\".", |
| 1729 "type": "string" |
| 1730 } |
| 1731 }, |
| 1732 "type": "object" |
| 1733 }, |
| 1734 "DeviceState": { |
| 1735 "description": "The state of a user's device, as accessed by the get
State and setState methods on device resources.", |
| 1736 "id": "DeviceState", |
| 1737 "properties": { |
| 1738 "accountState": { |
| 1739 "description": "The state of the Google account on the devic
e. \"enabled\" indicates that the Google account on the device can be used to ac
cess Google services (including Google Play), while \"disabled\" means that it c
annot. A new device is initially in the \"disabled\" state.", |
| 1740 "type": "string" |
| 1741 }, |
| 1742 "kind": { |
| 1743 "default": "androidenterprise#deviceState", |
| 1744 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#deviceState\".", |
| 1745 "type": "string" |
| 1746 } |
| 1747 }, |
| 1748 "type": "object" |
| 1749 }, |
| 1750 "DevicesListResponse": { |
| 1751 "description": "The device resources for the user.", |
| 1752 "id": "DevicesListResponse", |
| 1753 "properties": { |
| 1754 "device": { |
| 1755 "description": "A managed device.", |
| 1756 "items": { |
| 1757 "$ref": "Device" |
| 1758 }, |
| 1759 "type": "array" |
| 1760 }, |
| 1761 "kind": { |
| 1762 "default": "androidenterprise#devicesListResponse", |
| 1763 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#devicesListResponse\".", |
| 1764 "type": "string" |
| 1765 } |
| 1766 }, |
| 1767 "type": "object" |
| 1768 }, |
| 1769 "Enterprise": { |
| 1770 "description": "An enterprise resource represents a binding between
an organisation and their MDM.\n\nTo create an enterprise, an admin of the enter
prise must first go through a Play for Work sign-up flow. At the end of this the
admin will be presented with a token (a short opaque alphanumeric string). They
must then present this to the MDM, who then supplies it to the enroll method. U
ntil this is done the MDM will not have any access to the enterprise.\n\nAfter c
alling enroll the MDM should call setAccount to specify the service account that
will be allowed to act on behalf of the enterprise, which will be required for
access to the enterprise's data through this API. Only one call of setAccount is
allowed for a given enterprise; the only way to change the account later is to
unenroll the enterprise and enroll it again (obtaining a new token).\n\nThe MDM
can unenroll an enterprise in order to sever the binding between them. Re-enroll
ing an enterprise is possible, but requires a new token to be retrieved. Enterpr
ises.unenroll requires the MDM's credentials (as enroll does), not the enterpris
e's. Enterprises.unenroll can only be used for enterprises that were previously
enrolled with the enroll call. Any enterprises that were enrolled using the (dep
recated) Enterprises.insert call must be unenrolled with Enterprises.delete and
can then be re-enrolled using the Enterprises.enroll call.\n\nThe ID for an ente
rprise is an opaque string. It is returned by insert and enroll and can also be
retrieved if the enterprise's primary domain is known using the list method.", |
| 1771 "id": "Enterprise", |
| 1772 "properties": { |
| 1773 "id": { |
| 1774 "description": "The unique ID for the enterprise.", |
| 1775 "type": "string" |
| 1776 }, |
| 1777 "kind": { |
| 1778 "default": "androidenterprise#enterprise", |
| 1779 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#enterprise\".", |
| 1780 "type": "string" |
| 1781 }, |
| 1782 "name": { |
| 1783 "description": "The name of the enterprise, e.g. \"Example I
nc\".", |
| 1784 "type": "string" |
| 1785 }, |
| 1786 "primaryDomain": { |
| 1787 "annotations": { |
| 1788 "required": [ |
| 1789 "androidenterprise.enterprises.insert" |
| 1790 ] |
| 1791 }, |
| 1792 "description": "The enterprise's primary domain, e.g. \"exam
ple.com\".", |
| 1793 "type": "string" |
| 1794 } |
| 1795 }, |
| 1796 "type": "object" |
| 1797 }, |
| 1798 "EnterpriseAccount": { |
| 1799 "description": "A service account that can be used to authenticate a
s the enterprise to API calls that require such authentication.", |
| 1800 "id": "EnterpriseAccount", |
| 1801 "properties": { |
| 1802 "accountEmail": { |
| 1803 "description": "The email address of the service account.", |
| 1804 "type": "string" |
| 1805 }, |
| 1806 "kind": { |
| 1807 "default": "androidenterprise#enterpriseAccount", |
| 1808 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#enterpriseAccount\".", |
| 1809 "type": "string" |
| 1810 } |
| 1811 }, |
| 1812 "type": "object" |
| 1813 }, |
| 1814 "EnterprisesListResponse": { |
| 1815 "description": "The matching enterprise resources.", |
| 1816 "id": "EnterprisesListResponse", |
| 1817 "properties": { |
| 1818 "enterprise": { |
| 1819 "description": "An enterprise.", |
| 1820 "items": { |
| 1821 "$ref": "Enterprise" |
| 1822 }, |
| 1823 "type": "array" |
| 1824 }, |
| 1825 "kind": { |
| 1826 "default": "androidenterprise#enterprisesListResponse", |
| 1827 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#enterprisesListResponse\".", |
| 1828 "type": "string" |
| 1829 } |
| 1830 }, |
| 1831 "type": "object" |
| 1832 }, |
| 1833 "Entitlement": { |
| 1834 "description": "The existence of an entitlement resource means that
a user has the right to use a particular app on any of their devices. This might
be because the app is free or because they have been allocated a license to the
app from a group license purchased by the enterprise.\n\nIt should always be tr
ue that a user has an app installed on one of their devices only if they have an
entitlement to it. So if an entitlement is deleted, the app will be uninstalled
from all devices. Similarly if the user installs an app (and is permitted to do
so), or the MDM triggers an install of the app, an entitlement to that app is a
utomatically created. If this is impossible - e.g. the enterprise has not purcha
sed sufficient licenses - then installation fails.\n\nNote that entitlements are
always user specific, not device specific; a user may have an entitlement even
though they have not installed the app anywhere. Once they have an entitlement t
hey can install the app on multiple devices.\n\nThe API can be used to create an
entitlement. If the app is a free app, a group license for that app is created.
If it's a paid app, creating the entitlement consumes one license; it remains c
onsumed until the entitlement is removed. Optionally an installation of the app
on all the user's managed devices can be triggered at the time the entitlement i
s created. An entitlement cannot be created for an app if the app requires permi
ssions that the enterprise has not yet accepted.\n\nEntitlements for paid apps t
hat are due to purchases by the user on a non-managed profile will have \"userPu
rchase\" as entitlement reason; those entitlements cannot be removed via the API
.", |
| 1835 "id": "Entitlement", |
| 1836 "properties": { |
| 1837 "kind": { |
| 1838 "default": "androidenterprise#entitlement", |
| 1839 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlement\".", |
| 1840 "type": "string" |
| 1841 }, |
| 1842 "productId": { |
| 1843 "description": "The ID of the product that the entitlement i
s for, e.g. \"app:com.google.android.gm\".", |
| 1844 "type": "string" |
| 1845 }, |
| 1846 "reason": { |
| 1847 "description": "The reason for the entitlement, e.g. \"free\
" for free apps. This is temporary, it will be replaced by the acquisition kind
field of group licenses.", |
| 1848 "type": "string" |
| 1849 } |
| 1850 }, |
| 1851 "type": "object" |
| 1852 }, |
| 1853 "EntitlementsListResponse": { |
| 1854 "description": "The entitlement resources for the user.", |
| 1855 "id": "EntitlementsListResponse", |
| 1856 "properties": { |
| 1857 "entitlement": { |
| 1858 "description": "An entitlement of a user to a product (e.g.
an app). For example, a free app that they have installed, or a paid app that th
ey have been allocated a license to.", |
| 1859 "items": { |
| 1860 "$ref": "Entitlement" |
| 1861 }, |
| 1862 "type": "array" |
| 1863 }, |
| 1864 "kind": { |
| 1865 "default": "androidenterprise#entitlementsListResponse", |
| 1866 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlementsListResponse\".", |
| 1867 "type": "string" |
| 1868 } |
| 1869 }, |
| 1870 "type": "object" |
| 1871 }, |
| 1872 "GroupLicense": { |
| 1873 "description": "A group license object indicates a product that an e
nterprise admin has approved for use in the enterprise. The product may be free
or paid. For free products, a group license object is created in these cases: if
the enterprise admin approves a product in Google Play, if the product is added
to a collection, or if an entitlement for the product is created for a user via
the API. For paid products, a group license object is only created as part of t
he first bulk purchase of that product in Google Play done by the enterprise adm
in.\n\nThe API can be used to query group licenses; the available information in
cludes the total number of licenses purchased (for paid products) and the total
number of licenses that have been provisioned, i.e. the total number of user ent
itlements in existence for the product.\n\nGroup license objects are never delet
ed; if e.g. a free app is added to a collection and then removed, the group lice
nse will remain, allowing to keep track of any remaining entitlements. An enterp
rise admin may indicate they are no longer interested in the group license by ma
rking it as unapproved in Google Play.", |
| 1874 "id": "GroupLicense", |
| 1875 "properties": { |
| 1876 "acquisitionKind": { |
| 1877 "description": "How this group license was acquired. \"bulkP
urchase\" means that this group license object was created because the enterpris
e purchased licenses for this product; this is \"free\" otherwise (for free prod
ucts).", |
| 1878 "type": "string" |
| 1879 }, |
| 1880 "approval": { |
| 1881 "description": "Whether the product to which this group lice
nse relates is currently approved by the enterprise, as either \"approved\" or \
"unapproved\". Products are approved when a group license is first created, but
this approval may be revoked by an enterprise admin via Google Play. Unapproved
products will not be visible to end users in collections and new entitlements to
them should not normally be created.", |
| 1882 "type": "string" |
| 1883 }, |
| 1884 "kind": { |
| 1885 "default": "androidenterprise#groupLicense", |
| 1886 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#groupLicense\".", |
| 1887 "type": "string" |
| 1888 }, |
| 1889 "numProvisioned": { |
| 1890 "description": "The total number of provisioned licenses for
this product. Returned by read operations, but ignored in write operations.", |
| 1891 "format": "int32", |
| 1892 "type": "integer" |
| 1893 }, |
| 1894 "numPurchased": { |
| 1895 "description": "The number of purchased licenses (possibly i
n multiple purchases). If this field is omitted then there is no limit on the nu
mber of licenses that can be provisioned (e.g. if the acquisition kind is \"free
\").", |
| 1896 "format": "int32", |
| 1897 "type": "integer" |
| 1898 }, |
| 1899 "productId": { |
| 1900 "description": "The ID of the product that the license is fo
r, e.g. \"app:com.google.android.gm\".", |
| 1901 "type": "string" |
| 1902 } |
| 1903 }, |
| 1904 "type": "object" |
| 1905 }, |
| 1906 "GroupLicenseUsersListResponse": { |
| 1907 "description": "The user resources for the group license.", |
| 1908 "id": "GroupLicenseUsersListResponse", |
| 1909 "properties": { |
| 1910 "kind": { |
| 1911 "default": "androidenterprise#groupLicenseUsersListResponse"
, |
| 1912 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#groupLicenseUsersListResponse\".", |
| 1913 "type": "string" |
| 1914 }, |
| 1915 "user": { |
| 1916 "description": "A user of an enterprise.", |
| 1917 "items": { |
| 1918 "$ref": "User" |
| 1919 }, |
| 1920 "type": "array" |
| 1921 } |
| 1922 }, |
| 1923 "type": "object" |
| 1924 }, |
| 1925 "GroupLicensesListResponse": { |
| 1926 "description": "The grouplicense resources for the enterprise.", |
| 1927 "id": "GroupLicensesListResponse", |
| 1928 "properties": { |
| 1929 "groupLicense": { |
| 1930 "description": "A group license for a product approved for u
se in the enterprise.", |
| 1931 "items": { |
| 1932 "$ref": "GroupLicense" |
| 1933 }, |
| 1934 "type": "array" |
| 1935 }, |
| 1936 "kind": { |
| 1937 "default": "androidenterprise#groupLicensesListResponse", |
| 1938 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#groupLicensesListResponse\".", |
| 1939 "type": "string" |
| 1940 } |
| 1941 }, |
| 1942 "type": "object" |
| 1943 }, |
| 1944 "Install": { |
| 1945 "description": "The existence of an install resource indicates that
an app is installed on a particular device (or that an install is pending).\n\nT
he API can be used to create an install resource using the update method. This t
riggers the actual install of the app on the device. If the user does not alread
y have an entitlement for the app then an attempt is made to create one. If this
fails (e.g. because the app is not free and there is no available license) then
the creation of the install fails.\n\nThe API can also be used to update an ins
talled app. If the update method is used on an existing install then the app wil
l be updated to the latest available version.\n\nNote that it is not possible to
force the installation of a specific version of an app; the version code is rea
d-only.\n\nIf a user installs an app themselves (as permitted by the enterprise)
, then again an install resource and possibly an entitlement resource are automa
tically created.\n\nThe API can also be used to delete an install resource, whic
h triggers the removal of the app from the device. Note that deleting an install
does not automatically remove the corresponding entitlement, even if there are
no remaining installs. The install resource will also be deleted if the user uni
nstalls the app themselves.", |
| 1946 "id": "Install", |
| 1947 "properties": { |
| 1948 "installState": { |
| 1949 "description": "Install state. The state \"installPending\"
means that an install request has recently been made and download to the device
is in progress. The state \"installed\" means that the app has been installed. T
his field is read-only.", |
| 1950 "type": "string" |
| 1951 }, |
| 1952 "kind": { |
| 1953 "default": "androidenterprise#install", |
| 1954 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#install\".", |
| 1955 "type": "string" |
| 1956 }, |
| 1957 "productId": { |
| 1958 "description": "The ID of the product that the install is fo
r, e.g. \"app:com.google.android.gm\".", |
| 1959 "type": "string" |
| 1960 }, |
| 1961 "versionCode": { |
| 1962 "description": "The version of the installed product. Guaran
teed to be set only if the install state is \"installed\".", |
| 1963 "format": "int32", |
| 1964 "type": "integer" |
| 1965 } |
| 1966 }, |
| 1967 "type": "object" |
| 1968 }, |
| 1969 "InstallsListResponse": { |
| 1970 "description": "The install resources for the device.", |
| 1971 "id": "InstallsListResponse", |
| 1972 "properties": { |
| 1973 "install": { |
| 1974 "description": "An installation of an app for a user on a sp
ecific device. The existence of an install implies that the user must have an en
titlement to the app.", |
| 1975 "items": { |
| 1976 "$ref": "Install" |
| 1977 }, |
| 1978 "type": "array" |
| 1979 }, |
| 1980 "kind": { |
| 1981 "default": "androidenterprise#installsListResponse", |
| 1982 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#installsListResponse\".", |
| 1983 "type": "string" |
| 1984 } |
| 1985 }, |
| 1986 "type": "object" |
| 1987 }, |
| 1988 "Permission": { |
| 1989 "description": "A permission represents some extra capability, to be
granted to an Android app, which requires explicit consent. An enterprise admin
must consent to these permissions on behalf of their users before an entitlemen
t for the app can be created.\n\nThe permissions collection is read-only. The in
formation provided for each permission (localized name and description) is inten
ded to be used in the MDM user interface when obtaining consent from the enterpr
ise.", |
| 1990 "id": "Permission", |
| 1991 "properties": { |
| 1992 "description": { |
| 1993 "description": "A longer description of the permissions givi
ng more details of what it affects.", |
| 1994 "type": "string" |
| 1995 }, |
| 1996 "kind": { |
| 1997 "default": "androidenterprise#permission", |
| 1998 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#permission\".", |
| 1999 "type": "string" |
| 2000 }, |
| 2001 "name": { |
| 2002 "description": "The name of the permission.", |
| 2003 "type": "string" |
| 2004 }, |
| 2005 "permissionId": { |
| 2006 "description": "An opaque string uniquely identifying the pe
rmission.", |
| 2007 "type": "string" |
| 2008 } |
| 2009 }, |
| 2010 "type": "object" |
| 2011 }, |
| 2012 "Product": { |
| 2013 "description": "A product represents an app in the Google Play Store
that is available to at least some users in the enterprise. (Some apps are rest
ricted to a single enterprise, and no information about them is made available o
utside that enterprise.)\n\nThe information provided for each product (localized
name, icon, link to the full Google Play details page) is intended to allow a b
asic representation of the product within an MDM user interface.", |
| 2014 "id": "Product", |
| 2015 "properties": { |
| 2016 "authorName": { |
| 2017 "description": "The name of the author of the product (e.g.
the app developer).", |
| 2018 "type": "string" |
| 2019 }, |
| 2020 "detailsUrl": { |
| 2021 "description": "A link to the (consumer) Google Play details
page for the product.", |
| 2022 "type": "string" |
| 2023 }, |
| 2024 "iconUrl": { |
| 2025 "description": "A link to an image that can be used as an ic
on for the product.", |
| 2026 "type": "string" |
| 2027 }, |
| 2028 "kind": { |
| 2029 "default": "androidenterprise#product", |
| 2030 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#product\".", |
| 2031 "type": "string" |
| 2032 }, |
| 2033 "productId": { |
| 2034 "description": "A string of the form \"app:\n\" - e.g. \"app
:com.google.android.gm\" represents the GMail app.", |
| 2035 "type": "string" |
| 2036 }, |
| 2037 "title": { |
| 2038 "description": "The name of the product.", |
| 2039 "type": "string" |
| 2040 }, |
| 2041 "workDetailsUrl": { |
| 2042 "description": "A link to the Google Play for Work details p
age for the product, for use by an Enterprise administrator.", |
| 2043 "type": "string" |
| 2044 } |
| 2045 }, |
| 2046 "type": "object" |
| 2047 }, |
| 2048 "ProductPermission": { |
| 2049 "description": "A product permissions resource represents the set of
permissions required by a specific app and whether or not they have been accept
ed by an enterprise admin.\n\nThe API can be used to read the set of permissions
, and also to update the set to indicate that permissions have been accepted.", |
| 2050 "id": "ProductPermission", |
| 2051 "properties": { |
| 2052 "permissionId": { |
| 2053 "description": "An opaque string uniquely identifying the pe
rmission.", |
| 2054 "type": "string" |
| 2055 }, |
| 2056 "state": { |
| 2057 "description": "Whether the permission has been accepted or
not.", |
| 2058 "type": "string" |
| 2059 } |
| 2060 }, |
| 2061 "type": "object" |
| 2062 }, |
| 2063 "ProductPermissions": { |
| 2064 "description": "Information about the permissions required by a spec
ific app and whether they have been accepted by the enterprise.", |
| 2065 "id": "ProductPermissions", |
| 2066 "properties": { |
| 2067 "kind": { |
| 2068 "default": "androidenterprise#productPermissions", |
| 2069 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#productPermissions\".", |
| 2070 "type": "string" |
| 2071 }, |
| 2072 "permission": { |
| 2073 "annotations": { |
| 2074 "required": [ |
| 2075 "androidenterprise.products.updatePermissions" |
| 2076 ] |
| 2077 }, |
| 2078 "description": "The permissions required by the app.", |
| 2079 "items": { |
| 2080 "$ref": "ProductPermission" |
| 2081 }, |
| 2082 "type": "array" |
| 2083 }, |
| 2084 "productId": { |
| 2085 "description": "The ID of the app that the permissions relat
e to, e.g. \"app:com.google.android.gm\".", |
| 2086 "type": "string" |
| 2087 } |
| 2088 }, |
| 2089 "type": "object" |
| 2090 }, |
| 2091 "User": { |
| 2092 "description": "A user resource represents an individual user within
the enterprise's domain.\n\nNote that each user is associated with a Google acc
ount based on the user's corporate email address (which must be in one of the en
terprise's domains). As part of installing an MDM app to manage a device the Goo
gle account must be provisioned to the device, and so the user resource must be
created before that. This can be done using the Google Admin SDK Directory API.\
n\nThe ID for a user is an opaque string. It can be retrieved using the list met
hod queried by the user's primary email address.", |
| 2093 "id": "User", |
| 2094 "properties": { |
| 2095 "id": { |
| 2096 "description": "The unique ID for the user.", |
| 2097 "type": "string" |
| 2098 }, |
| 2099 "kind": { |
| 2100 "default": "androidenterprise#user", |
| 2101 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#user\".", |
| 2102 "type": "string" |
| 2103 }, |
| 2104 "primaryEmail": { |
| 2105 "description": "The user's primary email, e.g. \"jsmith@exam
ple.com\".", |
| 2106 "type": "string" |
| 2107 } |
| 2108 }, |
| 2109 "type": "object" |
| 2110 }, |
| 2111 "UserToken": { |
| 2112 "description": "A UserToken is used by a user when setting up a mana
ged device or profile with their work account on a device. When the user enters
their email address and token (activation code) the appropriate MDM app can be a
utomatically downloaded.", |
| 2113 "id": "UserToken", |
| 2114 "properties": { |
| 2115 "kind": { |
| 2116 "default": "androidenterprise#userToken", |
| 2117 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#userToken\".", |
| 2118 "type": "string" |
| 2119 }, |
| 2120 "token": { |
| 2121 "description": "The token (activation code) to be entered by
the user. This consists of a sequence of decimal digits. Note that the leading
digit may be 0.", |
| 2122 "type": "string" |
| 2123 }, |
| 2124 "userId": { |
| 2125 "description": "The unique ID for the user.", |
| 2126 "type": "string" |
| 2127 } |
| 2128 }, |
| 2129 "type": "object" |
| 2130 }, |
| 2131 "UsersListResponse": { |
| 2132 "description": "The matching user resources.", |
| 2133 "id": "UsersListResponse", |
| 2134 "properties": { |
| 2135 "kind": { |
| 2136 "default": "androidenterprise#usersListResponse", |
| 2137 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#usersListResponse\".", |
| 2138 "type": "string" |
| 2139 }, |
| 2140 "user": { |
| 2141 "description": "A user of an enterprise.", |
| 2142 "items": { |
| 2143 "$ref": "User" |
| 2144 }, |
| 2145 "type": "array" |
| 2146 } |
| 2147 }, |
| 2148 "type": "object" |
| 2149 } |
| 2150 }, |
| 2151 "servicePath": "androidenterprise/v1/", |
| 2152 "title": "Google Play MDM API", |
| 2153 "version": "v1" |
| 2154 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 1078053002:
Roll of googleapis as of 4/7/2015. (Closed)
Base URL: https://github.com/dart-lang/googleapis.git@master