| OLD | NEW |
| 1 { | 1 { |
| 2 "auth": { | 2 "auth": { |
| 3 "oauth2": { | 3 "oauth2": { |
| 4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/androidenterprise": { | 5 "https://www.googleapis.com/auth/androidenterprise": { |
| 6 "description": "Manage corporate Android devices" | 6 "description": "Manage corporate Android devices" |
| 7 } | 7 } |
| 8 } | 8 } |
| 9 } | 9 } |
| 10 }, | 10 }, |
| 11 "basePath": "/androidenterprise/v1/", | 11 "basePath": "/androidenterprise/v1/", |
| 12 "baseUrl": "https://www.googleapis.com/androidenterprise/v1/", | 12 "baseUrl": "https://www.googleapis.com/androidenterprise/v1/", |
| 13 "batchPath": "batch", | 13 "batchPath": "batch", |
| 14 "canonicalName": "Android Enterprise", | 14 "canonicalName": "Android Enterprise", |
| 15 "description": "Allows MDMs/EMMs and enterprises to manage the deployment of
apps to Android for Work users.", | 15 "description": "Allows MDMs/EMMs and enterprises to manage the deployment of
apps to Android for Work users.", |
| 16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
| 17 "documentationLink": "https://developers.google.com/android/work/play/emm-ap
i", | 17 "documentationLink": "https://developers.google.com/android/work/play/emm-ap
i", |
| 18 "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/4xdfCsFKqY63nj0AgziCWDL1CtA\"", | 18 "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/oDGCBWQ3TbSodDSQVvns_CkjrJY\"", |
| 19 "icons": { | 19 "icons": { |
| 20 "x16": "https://www.google.com/images/icons/product/android-16.png", | 20 "x16": "https://www.google.com/images/icons/product/android-16.png", |
| 21 "x32": "https://www.google.com/images/icons/product/android-32.png" | 21 "x32": "https://www.google.com/images/icons/product/android-32.png" |
| 22 }, | 22 }, |
| 23 "id": "androidenterprise:v1", | 23 "id": "androidenterprise:v1", |
| 24 "kind": "discovery#restDescription", | 24 "kind": "discovery#restDescription", |
| 25 "name": "androidenterprise", | 25 "name": "androidenterprise", |
| 26 "ownerDomain": "google.com", | 26 "ownerDomain": "google.com", |
| 27 "ownerName": "Google", | 27 "ownerName": "Google", |
| 28 "parameters": { | 28 "parameters": { |
| (...skipping 548 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 577 }, | 577 }, |
| 578 "scopes": [ | 578 "scopes": [ |
| 579 "https://www.googleapis.com/auth/androidenterprise" | 579 "https://www.googleapis.com/auth/androidenterprise" |
| 580 ] | 580 ] |
| 581 } | 581 } |
| 582 } | 582 } |
| 583 }, | 583 }, |
| 584 "enterprises": { | 584 "enterprises": { |
| 585 "methods": { | 585 "methods": { |
| 586 "delete": { | 586 "delete": { |
| 587 "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 "description": "Deletes the binding between the EMM 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.", |
| 588 "httpMethod": "DELETE", | 588 "httpMethod": "DELETE", |
| 589 "id": "androidenterprise.enterprises.delete", | 589 "id": "androidenterprise.enterprises.delete", |
| 590 "parameterOrder": [ | 590 "parameterOrder": [ |
| 591 "enterpriseId" | 591 "enterpriseId" |
| 592 ], | 592 ], |
| 593 "parameters": { | 593 "parameters": { |
| 594 "enterpriseId": { | 594 "enterpriseId": { |
| 595 "description": "The ID of the enterprise.", | 595 "description": "The ID of the enterprise.", |
| 596 "location": "path", | 596 "location": "path", |
| 597 "required": true, | 597 "required": true, |
| 598 "type": "string" | 598 "type": "string" |
| 599 } | 599 } |
| 600 }, | 600 }, |
| 601 "path": "enterprises/{enterpriseId}", | 601 "path": "enterprises/{enterpriseId}", |
| 602 "scopes": [ | 602 "scopes": [ |
| 603 "https://www.googleapis.com/auth/androidenterprise" | 603 "https://www.googleapis.com/auth/androidenterprise" |
| 604 ] | 604 ] |
| 605 }, | 605 }, |
| 606 "enroll": { | 606 "enroll": { |
| 607 "description": "Enrolls an enterprise with the calling MDM."
, | 607 "description": "Enrolls an enterprise with the calling EMM."
, |
| 608 "httpMethod": "POST", | 608 "httpMethod": "POST", |
| 609 "id": "androidenterprise.enterprises.enroll", | 609 "id": "androidenterprise.enterprises.enroll", |
| 610 "parameterOrder": [ | 610 "parameterOrder": [ |
| 611 "token" | 611 "token" |
| 612 ], | 612 ], |
| 613 "parameters": { | 613 "parameters": { |
| 614 "token": { | 614 "token": { |
| 615 "description": "The token provided by the enterprise
to register the MDM.", | 615 "description": "The token provided by the enterprise
to register the EMM.", |
| 616 "location": "query", | 616 "location": "query", |
| 617 "required": true, | 617 "required": true, |
| 618 "type": "string" | 618 "type": "string" |
| 619 } | 619 } |
| 620 }, | 620 }, |
| 621 "path": "enterprises/enroll", | 621 "path": "enterprises/enroll", |
| 622 "request": { | 622 "request": { |
| 623 "$ref": "Enterprise" | 623 "$ref": "Enterprise" |
| 624 }, | 624 }, |
| 625 "response": { | 625 "response": { |
| (...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 669 }, | 669 }, |
| 670 "path": "enterprises/{enterpriseId}/storeLayout", | 670 "path": "enterprises/{enterpriseId}/storeLayout", |
| 671 "response": { | 671 "response": { |
| 672 "$ref": "StoreLayout" | 672 "$ref": "StoreLayout" |
| 673 }, | 673 }, |
| 674 "scopes": [ | 674 "scopes": [ |
| 675 "https://www.googleapis.com/auth/androidenterprise" | 675 "https://www.googleapis.com/auth/androidenterprise" |
| 676 ] | 676 ] |
| 677 }, | 677 }, |
| 678 "insert": { | 678 "insert": { |
| 679 "description": "Establishes the binding between the MDM and
an enterprise. This is now deprecated; use enroll instead.", | 679 "description": "Establishes the binding between the EMM and
an enterprise. This is now deprecated; use enroll instead.", |
| 680 "httpMethod": "POST", | 680 "httpMethod": "POST", |
| 681 "id": "androidenterprise.enterprises.insert", | 681 "id": "androidenterprise.enterprises.insert", |
| 682 "parameterOrder": [ | 682 "parameterOrder": [ |
| 683 "token" | 683 "token" |
| 684 ], | 684 ], |
| 685 "parameters": { | 685 "parameters": { |
| 686 "token": { | 686 "token": { |
| 687 "description": "The token provided by the enterprise
to register the MDM.", | 687 "description": "The token provided by the enterprise
to register the EMM.", |
| 688 "location": "query", | 688 "location": "query", |
| 689 "required": true, | 689 "required": true, |
| 690 "type": "string" | 690 "type": "string" |
| 691 } | 691 } |
| 692 }, | 692 }, |
| 693 "path": "enterprises", | 693 "path": "enterprises", |
| 694 "request": { | 694 "request": { |
| 695 "$ref": "Enterprise" | 695 "$ref": "Enterprise" |
| 696 }, | 696 }, |
| 697 "response": { | 697 "response": { |
| (...skipping 20 matching lines...) Expand all Loading... |
| 718 }, | 718 }, |
| 719 "path": "enterprises", | 719 "path": "enterprises", |
| 720 "response": { | 720 "response": { |
| 721 "$ref": "EnterprisesListResponse" | 721 "$ref": "EnterprisesListResponse" |
| 722 }, | 722 }, |
| 723 "scopes": [ | 723 "scopes": [ |
| 724 "https://www.googleapis.com/auth/androidenterprise" | 724 "https://www.googleapis.com/auth/androidenterprise" |
| 725 ] | 725 ] |
| 726 }, | 726 }, |
| 727 "sendTestPushNotification": { | 727 "sendTestPushNotification": { |
| 728 "description": "Sends a test push notification to validate t
he MDM integration with the Google Cloud Pub/Sub service for this enterprise.", | 728 "description": "Sends a test push notification to validate t
he EMM integration with the Google Cloud Pub/Sub service for this enterprise.", |
| 729 "httpMethod": "POST", | 729 "httpMethod": "POST", |
| 730 "id": "androidenterprise.enterprises.sendTestPushNotificatio
n", | 730 "id": "androidenterprise.enterprises.sendTestPushNotificatio
n", |
| 731 "parameterOrder": [ | 731 "parameterOrder": [ |
| 732 "enterpriseId" | 732 "enterpriseId" |
| 733 ], | 733 ], |
| 734 "parameters": { | 734 "parameters": { |
| 735 "enterpriseId": { | 735 "enterpriseId": { |
| 736 "description": "The ID of the enterprise.", | 736 "description": "The ID of the enterprise.", |
| 737 "location": "path", | 737 "location": "path", |
| 738 "required": true, | 738 "required": true, |
| (...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 793 "$ref": "StoreLayout" | 793 "$ref": "StoreLayout" |
| 794 }, | 794 }, |
| 795 "response": { | 795 "response": { |
| 796 "$ref": "StoreLayout" | 796 "$ref": "StoreLayout" |
| 797 }, | 797 }, |
| 798 "scopes": [ | 798 "scopes": [ |
| 799 "https://www.googleapis.com/auth/androidenterprise" | 799 "https://www.googleapis.com/auth/androidenterprise" |
| 800 ] | 800 ] |
| 801 }, | 801 }, |
| 802 "unenroll": { | 802 "unenroll": { |
| 803 "description": "Unenrolls an enterprise from the calling MDM
.", | 803 "description": "Unenrolls an enterprise from the calling EMM
.", |
| 804 "httpMethod": "POST", | 804 "httpMethod": "POST", |
| 805 "id": "androidenterprise.enterprises.unenroll", | 805 "id": "androidenterprise.enterprises.unenroll", |
| 806 "parameterOrder": [ | 806 "parameterOrder": [ |
| 807 "enterpriseId" | 807 "enterpriseId" |
| 808 ], | 808 ], |
| 809 "parameters": { | 809 "parameters": { |
| 810 "enterpriseId": { | 810 "enterpriseId": { |
| 811 "description": "The ID of the enterprise.", | 811 "description": "The ID of the enterprise.", |
| 812 "location": "path", | 812 "location": "path", |
| 813 "required": true, | 813 "required": true, |
| (...skipping 706 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1520 }, | 1520 }, |
| 1521 "path": "enterprises/{enterpriseId}/products/{productId}/per
missions", | 1521 "path": "enterprises/{enterpriseId}/products/{productId}/per
missions", |
| 1522 "response": { | 1522 "response": { |
| 1523 "$ref": "ProductPermissions" | 1523 "$ref": "ProductPermissions" |
| 1524 }, | 1524 }, |
| 1525 "scopes": [ | 1525 "scopes": [ |
| 1526 "https://www.googleapis.com/auth/androidenterprise" | 1526 "https://www.googleapis.com/auth/androidenterprise" |
| 1527 ] | 1527 ] |
| 1528 }, | 1528 }, |
| 1529 "updatePermissions": { | 1529 "updatePermissions": { |
| 1530 "description": "Updates the set of Android app permissions f
or this app that have been accepted by the enterprise.", | 1530 "description": "This method has been deprecated. To programm
atically approve applications, you must use the iframe mechanism via the genera
teApprovalUrl and approve methods of the Products resource. For more informatio
n, see the Play EMM API usage requirements.\n\nThe updatePermissions method (de
precated) updates the set of Android app permissions for this app that have been
accepted by the enterprise.", |
| 1531 "httpMethod": "PUT", | 1531 "httpMethod": "PUT", |
| 1532 "id": "androidenterprise.products.updatePermissions", | 1532 "id": "androidenterprise.products.updatePermissions", |
| 1533 "parameterOrder": [ | 1533 "parameterOrder": [ |
| 1534 "enterpriseId", | 1534 "enterpriseId", |
| 1535 "productId" | 1535 "productId" |
| 1536 ], | 1536 ], |
| 1537 "parameters": { | 1537 "parameters": { |
| 1538 "enterpriseId": { | 1538 "enterpriseId": { |
| 1539 "description": "The ID of the enterprise.", | 1539 "description": "The ID of the enterprise.", |
| 1540 "location": "path", | 1540 "location": "path", |
| (...skipping 410 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1951 }, | 1951 }, |
| 1952 "scopes": [ | 1952 "scopes": [ |
| 1953 "https://www.googleapis.com/auth/androidenterprise" | 1953 "https://www.googleapis.com/auth/androidenterprise" |
| 1954 ] | 1954 ] |
| 1955 } | 1955 } |
| 1956 } | 1956 } |
| 1957 }, | 1957 }, |
| 1958 "users": { | 1958 "users": { |
| 1959 "methods": { | 1959 "methods": { |
| 1960 "generateToken": { | 1960 "generateToken": { |
| 1961 "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.", | 1961 "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.\n\nThis call only works with Google managed acco
unts.", |
| 1962 "httpMethod": "POST", | 1962 "httpMethod": "POST", |
| 1963 "id": "androidenterprise.users.generateToken", | 1963 "id": "androidenterprise.users.generateToken", |
| 1964 "parameterOrder": [ | 1964 "parameterOrder": [ |
| 1965 "enterpriseId", | 1965 "enterpriseId", |
| 1966 "userId" | 1966 "userId" |
| 1967 ], | 1967 ], |
| 1968 "parameters": { | 1968 "parameters": { |
| 1969 "enterpriseId": { | 1969 "enterpriseId": { |
| 1970 "description": "The ID of the enterprise.", | 1970 "description": "The ID of the enterprise.", |
| 1971 "location": "path", | 1971 "location": "path", |
| (...skipping 69 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2041 }, | 2041 }, |
| 2042 "path": "enterprises/{enterpriseId}/users/{userId}/available
ProductSet", | 2042 "path": "enterprises/{enterpriseId}/users/{userId}/available
ProductSet", |
| 2043 "response": { | 2043 "response": { |
| 2044 "$ref": "ProductSet" | 2044 "$ref": "ProductSet" |
| 2045 }, | 2045 }, |
| 2046 "scopes": [ | 2046 "scopes": [ |
| 2047 "https://www.googleapis.com/auth/androidenterprise" | 2047 "https://www.googleapis.com/auth/androidenterprise" |
| 2048 ] | 2048 ] |
| 2049 }, | 2049 }, |
| 2050 "list": { | 2050 "list": { |
| 2051 "description": "Looks up a user by email address. This only
works for Google managed users.", | 2051 "description": "Looks up a user by their primary email addre
ss.", |
| 2052 "httpMethod": "GET", | 2052 "httpMethod": "GET", |
| 2053 "id": "androidenterprise.users.list", | 2053 "id": "androidenterprise.users.list", |
| 2054 "parameterOrder": [ | 2054 "parameterOrder": [ |
| 2055 "enterpriseId", | 2055 "enterpriseId", |
| 2056 "email" | 2056 "email" |
| 2057 ], | 2057 ], |
| 2058 "parameters": { | 2058 "parameters": { |
| 2059 "email": { | 2059 "email": { |
| 2060 "description": "The exact primary email address of t
he user to look up.", | 2060 "description": "The exact primary email address of t
he user to look up.", |
| 2061 "location": "query", | 2061 "location": "query", |
| (...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2133 "response": { | 2133 "response": { |
| 2134 "$ref": "ProductSet" | 2134 "$ref": "ProductSet" |
| 2135 }, | 2135 }, |
| 2136 "scopes": [ | 2136 "scopes": [ |
| 2137 "https://www.googleapis.com/auth/androidenterprise" | 2137 "https://www.googleapis.com/auth/androidenterprise" |
| 2138 ] | 2138 ] |
| 2139 } | 2139 } |
| 2140 } | 2140 } |
| 2141 } | 2141 } |
| 2142 }, | 2142 }, |
| 2143 "revision": "20160106", | 2143 "revision": "20160302", |
| 2144 "rootUrl": "https://www.googleapis.com/", | 2144 "rootUrl": "https://www.googleapis.com/", |
| 2145 "schemas": { | 2145 "schemas": { |
| 2146 "AppRestrictionsSchema": { | 2146 "AppRestrictionsSchema": { |
| 2147 "description": "Represents the list of app restrictions available to
be pre-configured for the product.", | 2147 "description": "Represents the list of app restrictions available to
be pre-configured for the product.", |
| 2148 "id": "AppRestrictionsSchema", | 2148 "id": "AppRestrictionsSchema", |
| 2149 "properties": { | 2149 "properties": { |
| 2150 "kind": { | 2150 "kind": { |
| 2151 "default": "androidenterprise#appRestrictionsSchema", | 2151 "default": "androidenterprise#appRestrictionsSchema", |
| 2152 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#appRestrictionsSchema\".", | 2152 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#appRestrictionsSchema\".", |
| 2153 "type": "string" | 2153 "type": "string" |
| (...skipping 187 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2341 }, | 2341 }, |
| 2342 "kind": { | 2342 "kind": { |
| 2343 "default": "androidenterprise#collectionsListResponse", | 2343 "default": "androidenterprise#collectionsListResponse", |
| 2344 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#collectionsListResponse\".", | 2344 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#collectionsListResponse\".", |
| 2345 "type": "string" | 2345 "type": "string" |
| 2346 } | 2346 } |
| 2347 }, | 2347 }, |
| 2348 "type": "object" | 2348 "type": "object" |
| 2349 }, | 2349 }, |
| 2350 "Device": { | 2350 "Device": { |
| 2351 "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.", | 2351 "description": "A device resource represents a mobile device managed
by the EMM 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.", |
| 2352 "id": "Device", | 2352 "id": "Device", |
| 2353 "properties": { | 2353 "properties": { |
| 2354 "androidId": { | 2354 "androidId": { |
| 2355 "description": "The Google Play Services Android ID for the
device encoded as a lowercase hex string, e.g. \"123456789abcdef0\".", | 2355 "description": "The Google Play Services Android ID for the
device encoded as a lowercase hex string, e.g. \"123456789abcdef0\".", |
| 2356 "type": "string" | 2356 "type": "string" |
| 2357 }, | 2357 }, |
| 2358 "kind": { | 2358 "kind": { |
| 2359 "default": "androidenterprise#device", | 2359 "default": "androidenterprise#device", |
| 2360 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#device\".", | 2360 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#device\".", |
| 2361 "type": "string" | 2361 "type": "string" |
| 2362 }, | 2362 }, |
| 2363 "managementType": { | 2363 "managementType": { |
| 2364 "description": "The mechanism by which this device is manage
d by the MDM. \"managedDevice\" means that the MDM's app is a device owner. \"ma
nagedProfile\" means that the MDM's app is the profile owner (and there is a sep
arate personal profile which is not managed). \"containerApp\" means that the MD
M's app is managing the Android for Work container app on the device.", | 2364 "description": "The mechanism by which this device is manage
d by the EMM. \"managedDevice\" means that the EMM's app is a device owner. \"ma
nagedProfile\" means that the EMM's app is the profile owner (and there is a sep
arate personal profile which is not managed). \"containerApp\" means that the EM
M's app is managing the Android for Work container app on the device.", |
| 2365 "type": "string" | 2365 "type": "string" |
| 2366 } | 2366 } |
| 2367 }, | 2367 }, |
| 2368 "type": "object" | 2368 "type": "object" |
| 2369 }, | 2369 }, |
| 2370 "DeviceState": { | 2370 "DeviceState": { |
| 2371 "description": "The state of a user's device, as accessed by the get
State and setState methods on device resources.", | 2371 "description": "The state of a user's device, as accessed by the get
State and setState methods on device resources.", |
| 2372 "id": "DeviceState", | 2372 "id": "DeviceState", |
| 2373 "properties": { | 2373 "properties": { |
| 2374 "accountState": { | 2374 "accountState": { |
| (...skipping 21 matching lines...) Expand all Loading... |
| 2396 }, | 2396 }, |
| 2397 "kind": { | 2397 "kind": { |
| 2398 "default": "androidenterprise#devicesListResponse", | 2398 "default": "androidenterprise#devicesListResponse", |
| 2399 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#devicesListResponse\".", | 2399 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#devicesListResponse\".", |
| 2400 "type": "string" | 2400 "type": "string" |
| 2401 } | 2401 } |
| 2402 }, | 2402 }, |
| 2403 "type": "object" | 2403 "type": "object" |
| 2404 }, | 2404 }, |
| 2405 "Enterprise": { | 2405 "Enterprise": { |
| 2406 "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.", | 2406 "description": "An enterprise resource represents a binding between
an organisation and their EMM.\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 EMM, who then supplies it to the enroll method. U
ntil this is done the EMM will not have any access to the enterprise.\n\nAfter c
alling enroll the EMM 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 EMM
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 EMM'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.", |
| 2407 "id": "Enterprise", | 2407 "id": "Enterprise", |
| 2408 "properties": { | 2408 "properties": { |
| 2409 "id": { | 2409 "id": { |
| 2410 "description": "The unique ID for the enterprise.", | 2410 "description": "The unique ID for the enterprise.", |
| 2411 "type": "string" | 2411 "type": "string" |
| 2412 }, | 2412 }, |
| 2413 "kind": { | 2413 "kind": { |
| 2414 "default": "androidenterprise#enterprise", | 2414 "default": "androidenterprise#enterprise", |
| 2415 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#enterprise\".", | 2415 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#enterprise\".", |
| 2416 "type": "string" | 2416 "type": "string" |
| (...skipping 57 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2474 "type": "string" | 2474 "type": "string" |
| 2475 }, | 2475 }, |
| 2476 "topicName": { | 2476 "topicName": { |
| 2477 "description": "The name of the Cloud Pub/Sub topic to which
notifications for this enterprise's enrolled account will be sent.", | 2477 "description": "The name of the Cloud Pub/Sub topic to which
notifications for this enterprise's enrolled account will be sent.", |
| 2478 "type": "string" | 2478 "type": "string" |
| 2479 } | 2479 } |
| 2480 }, | 2480 }, |
| 2481 "type": "object" | 2481 "type": "object" |
| 2482 }, | 2482 }, |
| 2483 "Entitlement": { | 2483 "Entitlement": { |
| 2484 "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
.", | 2484 "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 EMM 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
.", |
| 2485 "id": "Entitlement", | 2485 "id": "Entitlement", |
| 2486 "properties": { | 2486 "properties": { |
| 2487 "kind": { | 2487 "kind": { |
| 2488 "default": "androidenterprise#entitlement", | 2488 "default": "androidenterprise#entitlement", |
| 2489 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlement\".", | 2489 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#entitlement\".", |
| 2490 "type": "string" | 2490 "type": "string" |
| 2491 }, | 2491 }, |
| 2492 "productId": { | 2492 "productId": { |
| 2493 "description": "The ID of the product that the entitlement i
s for, e.g. \"app:com.google.android.gm\".", | 2493 "description": "The ID of the product that the entitlement i
s for, e.g. \"app:com.google.android.gm\".", |
| 2494 "type": "string" | 2494 "type": "string" |
| (...skipping 149 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2644 "type": "string" | 2644 "type": "string" |
| 2645 }, | 2645 }, |
| 2646 "text": { | 2646 "text": { |
| 2647 "description": "The text localized in the associated locale.
", | 2647 "description": "The text localized in the associated locale.
", |
| 2648 "type": "string" | 2648 "type": "string" |
| 2649 } | 2649 } |
| 2650 }, | 2650 }, |
| 2651 "type": "object" | 2651 "type": "object" |
| 2652 }, | 2652 }, |
| 2653 "Permission": { | 2653 "Permission": { |
| 2654 "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.", | 2654 "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 EMM user interface when obtaining consent from the enterpr
ise.", |
| 2655 "id": "Permission", | 2655 "id": "Permission", |
| 2656 "properties": { | 2656 "properties": { |
| 2657 "description": { | 2657 "description": { |
| 2658 "description": "A longer description of the permissions givi
ng more details of what it affects.", | 2658 "description": "A longer description of the permissions givi
ng more details of what it affects.", |
| 2659 "type": "string" | 2659 "type": "string" |
| 2660 }, | 2660 }, |
| 2661 "kind": { | 2661 "kind": { |
| 2662 "default": "androidenterprise#permission", | 2662 "default": "androidenterprise#permission", |
| 2663 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#permission\".", | 2663 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#permission\".", |
| 2664 "type": "string" | 2664 "type": "string" |
| 2665 }, | 2665 }, |
| 2666 "name": { | 2666 "name": { |
| 2667 "description": "The name of the permission.", | 2667 "description": "The name of the permission.", |
| 2668 "type": "string" | 2668 "type": "string" |
| 2669 }, | 2669 }, |
| 2670 "permissionId": { | 2670 "permissionId": { |
| 2671 "description": "An opaque string uniquely identifying the pe
rmission.", | 2671 "description": "An opaque string uniquely identifying the pe
rmission.", |
| 2672 "type": "string" | 2672 "type": "string" |
| 2673 } | 2673 } |
| 2674 }, | 2674 }, |
| 2675 "type": "object" | 2675 "type": "object" |
| 2676 }, | 2676 }, |
| 2677 "Product": { | 2677 "Product": { |
| 2678 "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.", | 2678 "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 EMM user interface.", |
| 2679 "id": "Product", | 2679 "id": "Product", |
| 2680 "properties": { | 2680 "properties": { |
| 2681 "appVersion": { | 2681 "appVersion": { |
| 2682 "description": "App versions currently available for this pr
oduct. The returned list contains only public versions. Alpha and beta versions
are not included.", | 2682 "description": "App versions currently available for this pr
oduct. The returned list contains only public versions. Alpha and beta versions
are not included.", |
| 2683 "items": { | 2683 "items": { |
| 2684 "$ref": "AppVersion" | 2684 "$ref": "AppVersion" |
| 2685 }, | 2685 }, |
| 2686 "type": "array" | 2686 "type": "array" |
| 2687 }, | 2687 }, |
| 2688 "authorName": { | 2688 "authorName": { |
| (...skipping 234 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2923 "description": "Ordered list of localized strings giving the
name of this page. The text displayed is the one that best matches the user loc
ale, or the first entry if there is no good match. There needs to be at least on
e entry.", | 2923 "description": "Ordered list of localized strings giving the
name of this page. The text displayed is the one that best matches the user loc
ale, or the first entry if there is no good match. There needs to be at least on
e entry.", |
| 2924 "items": { | 2924 "items": { |
| 2925 "$ref": "LocalizedText" | 2925 "$ref": "LocalizedText" |
| 2926 }, | 2926 }, |
| 2927 "type": "array" | 2927 "type": "array" |
| 2928 } | 2928 } |
| 2929 }, | 2929 }, |
| 2930 "type": "object" | 2930 "type": "object" |
| 2931 }, | 2931 }, |
| 2932 "User": { | 2932 "User": { |
| 2933 "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.", | 2933 "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 the EMM's DPC app to manage a device
the Google account must be provisioned to the device, and so the user resource m
ust be created before that. This can be done using the Google Admin SDK Director
y API.\n\nThe ID for a user is an opaque string. It can be retrieved using the l
ist method queried by the user's primary email address.", |
| 2934 "id": "User", | 2934 "id": "User", |
| 2935 "properties": { | 2935 "properties": { |
| 2936 "id": { | 2936 "id": { |
| 2937 "description": "The unique ID for the user.", | 2937 "description": "The unique ID for the user.", |
| 2938 "type": "string" | 2938 "type": "string" |
| 2939 }, | 2939 }, |
| 2940 "kind": { | 2940 "kind": { |
| 2941 "default": "androidenterprise#user", | 2941 "default": "androidenterprise#user", |
| 2942 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#user\".", | 2942 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#user\".", |
| 2943 "type": "string" | 2943 "type": "string" |
| 2944 }, | 2944 }, |
| 2945 "primaryEmail": { | 2945 "primaryEmail": { |
| 2946 "description": "The user's primary email, e.g. \"jsmith@exam
ple.com\". Will always be set for Google managed users and not set for EMM manag
ed users.", | 2946 "description": "The user's primary email, e.g. \"jsmith@exam
ple.com\". Will always be set for Google managed users and not set for EMM manag
ed users.", |
| 2947 "type": "string" | 2947 "type": "string" |
| 2948 } | 2948 } |
| 2949 }, | 2949 }, |
| 2950 "type": "object" | 2950 "type": "object" |
| 2951 }, | 2951 }, |
| 2952 "UserToken": { | 2952 "UserToken": { |
| 2953 "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.", | 2953 "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 EMM app can be a
utomatically downloaded.", |
| 2954 "id": "UserToken", | 2954 "id": "UserToken", |
| 2955 "properties": { | 2955 "properties": { |
| 2956 "kind": { | 2956 "kind": { |
| 2957 "default": "androidenterprise#userToken", | 2957 "default": "androidenterprise#userToken", |
| 2958 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#userToken\".", | 2958 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"androidenterprise#userToken\".", |
| 2959 "type": "string" | 2959 "type": "string" |
| 2960 }, | 2960 }, |
| 2961 "token": { | 2961 "token": { |
| 2962 "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.", | 2962 "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.", |
| 2963 "type": "string" | 2963 "type": "string" |
| (...skipping 22 matching lines...) Expand all Loading... |
| 2986 "type": "array" | 2986 "type": "array" |
| 2987 } | 2987 } |
| 2988 }, | 2988 }, |
| 2989 "type": "object" | 2989 "type": "object" |
| 2990 } | 2990 } |
| 2991 }, | 2991 }, |
| 2992 "servicePath": "androidenterprise/v1/", | 2992 "servicePath": "androidenterprise/v1/", |
| 2993 "title": "Google Play EMM API", | 2993 "title": "Google Play EMM API", |
| 2994 "version": "v1" | 2994 "version": "v1" |
| 2995 } | 2995 } |
| OLD | NEW |