Api-roll 42: 2016-11-08

discovery/googleapis/androidenterprise__v1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/androidenterprise": {
                     "description": "Manage corporate Android devices"
                 }
             }
         }
     },
     "basePath": "/androidenterprise/v1/",
     "baseUrl": "https://www.googleapis.com/androidenterprise/v1/",
     "batchPath": "batch",
     "canonicalName": "Android Enterprise",
     "description": "Manages the deployment of apps to Android for Work users.",
     "discoveryVersion": "v1",
     "documentationLink": "https://developers.google.com/android/work/play/emm-api",
-    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/uiNJ6ExiEEycTZwke1yNGg1_Vg8\"",
+    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/IK528lrZ_G3wj2ykOVn5EPb9raM\"",
     "icons": {
         "x16": "https://www.google.com/images/icons/product/android-16.png",
         "x32": "https://www.google.com/images/icons/product/android-32.png"
     },
     "id": "androidenterprise:v1",
     "kind": "discovery#restDescription",
     "name": "androidenterprise",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 587 matching lines @@
                         }
                     },
                     "path": "enterprises/completeSignup",
                     "response": {
                         "$ref": "Enterprise"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
                 },
+                "createWebToken": {
+                    "description": "Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the Play for Work javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.",
+                    "httpMethod": "POST",
+                    "id": "androidenterprise.enterprises.createWebToken",
+                    "parameterOrder": [
+                        "enterpriseId"
+                    ],
+                    "parameters": {
+                        "enterpriseId": {
+                            "description": "The ID of the enterprise.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "enterprises/{enterpriseId}/createWebToken",
+                    "request": {
+                        "$ref": "AdministratorWebTokenSpec"
+                    },
+                    "response": {
+                        "$ref": "AdministratorWebToken"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/androidenterprise"
+                    ]
+                },
                 "delete": {
                     "description": "Deletes the binding between the EMM and enterprise. This is now deprecated; use this to unenroll customers that were previously enrolled with the 'insert' call, then enroll them again with the 'enroll' call.",
                     "httpMethod": "DELETE",
                     "id": "androidenterprise.enterprises.delete",
                     "parameterOrder": [
                         "enterpriseId"
                     ],
                     "parameters": {
                         "enterpriseId": {
                             "description": "The ID of the enterprise.",
@@ skipping 177 matching lines @@
                     },
                     "path": "enterprises",
                     "response": {
                         "$ref": "EnterprisesListResponse"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
                 },
                 "pullNotificationSet": {
-                    "description": "Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.\nA notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty.\nNotifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy.\nMultiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending.",
+                    "description": "Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending.\nA notification set returned needs to be acknowledged within 20 seconds by calling Enterprises​.AcknowledgeNotificationSet, unless the notification set is empty.\nNotifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy.\nMultiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending.\nIf no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.",
                     "httpMethod": "POST",
                     "id": "androidenterprise.enterprises.pullNotificationSet",
                     "parameters": {
                         "requestMode": {
-                            "description": "The request mode for pulling notifications. If omitted, defaults to WAIT_FOR_NOTIFCATIONS.\nIf this is set to WAIT_FOR_NOTIFCATIONS, the request will eventually timeout, in which case it should be retried.",
+                            "description": "The request mode for pulling notifications.\nSpecifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time.\nSpeciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present.\nIf omitted, defaults to waitForNotifications.",
                             "enum": [
                                 "returnImmediately",
                                 "waitForNotifications"
                             ],
                             "enumDescriptions": [
                                 "",
                                 ""
                             ],
                             "location": "query",
                             "type": "string"
@@ skipping 50 matching lines @@
                         "$ref": "EnterpriseAccount"
                     },
                     "response": {
                         "$ref": "EnterpriseAccount"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
                 },
                 "setStoreLayout": {
-                    "description": "Sets the store layout for the enterprise.",
+                    "description": "Sets the store layout for the enterprise. By default, storeLayoutType is set to \"basic\" and the basic store layout is enabled. The basic layout only contains apps approved by the administrator, and that have been added to the available product set for a user (using the  setAvailableProductSet call). Apps on the page are sorted in order of their product ID value. If you create a custom store layout (by setting storeLayoutType = \"custom\"), the basic store layout is disabled.",
                     "httpMethod": "PUT",
                     "id": "androidenterprise.enterprises.setStoreLayout",
                     "parameterOrder": [
                         "enterpriseId"
                     ],
                     "parameters": {
                         "enterpriseId": {
                             "description": "The ID of the enterprise.",
                             "location": "path",
                             "required": true,
@@ skipping 1871 matching lines @@
                     },
                     "path": "enterprises/{enterpriseId}/users/{userId}/availableProductSet",
                     "response": {
                         "$ref": "ProductSet"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
                 },
                 "insert": {
-                    "description": "Creates a new EMM-managed user.\n\nThe Users resource passed in the body of the request should include an accountIdentifier and an accountType.",
+                    "description": "Creates a new EMM-managed user.\n\nThe Users resource passed in the body of the request should include an accountIdentifier and an accountType.\nIf a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.",
                     "httpMethod": "POST",
                     "id": "androidenterprise.users.insert",
                     "parameterOrder": [
                         "enterpriseId"
                     ],
                     "parameters": {
                         "enterpriseId": {
                             "description": "The ID of the enterprise.",
                             "location": "path",
                             "required": true,
@@ skipping 163 matching lines @@
                     "response": {
                         "$ref": "User"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/androidenterprise"
                     ]
                 }
             }
         }
     },
-    "revision": "20160818",
+    "revision": "20161025",
     "rootUrl": "https://www.googleapis.com/",
     "schemas": {
         "Administrator": {
             "description": "This represents an enterprise administrator who can manage the enterprise in the Google Play for Work Store.",
             "id": "Administrator",
             "properties": {
                 "email": {
                     "description": "The administrator's email address.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
+        "AdministratorWebToken": {
+            "description": "A token authorizing an administrator to access an iframe.",
+            "id": "AdministratorWebToken",
+            "properties": {
+                "kind": {
+                    "default": "androidenterprise#administratorWebToken",
+                    "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebToken\".",
+                    "type": "string"
+                },
+                "token": {
+                    "description": "An opaque token to be passed to the Play front-end to generate an iframe.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "AdministratorWebTokenSpec": {
+            "description": "Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with.",
+            "id": "AdministratorWebTokenSpec",
+            "properties": {
+                "kind": {
+                    "default": "androidenterprise#administratorWebTokenSpec",
+                    "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#administratorWebTokenSpec\".",
+                    "type": "string"
+                },
+                "parent": {
+                    "description": "The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may not be hosted at other URIs. This URI must be https.",
+                    "type": "string"
+                },
+                "permission": {
+                    "description": "The list of permissions the admin is granted within the iframe. The admin will only be allowed to view an iframe if they have all of the permissions associated with it. The only valid value is \"approveApps\" that will allow the admin to access the iframe in \"approve\" mode.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "AppRestrictionsSchema": {
             "description": "Represents the list of app restrictions available to be pre-configured for the product.",
             "id": "AppRestrictionsSchema",
             "properties": {
                 "kind": {
                     "default": "androidenterprise#appRestrictionsSchema",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#appRestrictionsSchema\".",
                     "type": "string"
                 },
                 "restrictions": {
@@ skipping 16 matching lines @@
                 }
             },
             "type": "object"
         },
         "AppRestrictionsSchemaRestriction": {
             "description": "A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.",
             "id": "AppRestrictionsSchemaRestriction",
             "properties": {
                 "defaultValue": {
                     "$ref": "AppRestrictionsSchemaRestrictionRestrictionValue",
-                    "description": "The default value of the restriction."
+                    "description": "The default value of the restriction. bundle and bundleArray restrictions never have a default value."
                 },
                 "description": {
                     "description": "A longer description of the restriction, giving more detail of what it affects.",
                     "type": "string"
                 },
                 "entry": {
                     "description": "For choice or multiselect restrictions, the list of possible entries' human-readable names.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "entryValue": {
-                    "description": "For choice or multiselect restrictions, the list of possible entries' machine-readable values.",
+                    "description": "For choice or multiselect restrictions, the list of possible entries' machine-readable values. These values should be used in the configuration, either as a single string value for a choice restriction or in a stringArray for a multiselect restriction.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "key": {
                     "description": "The unique key that the product uses to identify the restriction, e.g. \"com.google.android.gm.fieldname\".",
                     "type": "string"
                 },
                 "nestedRestriction": {
-                    "description": "For bundle or bundleArray restrictions, the list of nested restrictions.",
+                    "description": "For bundle or bundleArray restrictions, the list of nested restrictions. A bundle restriction is always nested within a bundleArray restriction, and a bundleArray restriction is at most two levels deep.",
                     "items": {
                         "$ref": "AppRestrictionsSchemaRestriction"
                     },
                     "type": "array"
                 },
                 "restrictionType": {
                     "description": "The type of the restriction.",
                     "type": "string"
                 },
                 "title": {
@@ skipping 181 matching lines @@
                 "androidId": {
                     "description": "The Google Play Services Android ID for the device encoded as a lowercase hex string, e.g. \"123456789abcdef0\".",
                     "type": "string"
                 },
                 "kind": {
                     "default": "androidenterprise#device",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#device\".",
                     "type": "string"
                 },
                 "managementType": {
-                    "description": "Identifies the extent to which the device is controlled by an Android for Work EMM in various deployment configurations.\nPossible values include: \n- \"managedDevice\"—A device that has the EMM's device policy controller (DPC) as the device owner.\n- \"managedProfile\"—A device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC.\n- \"containerApp\"—A device running the Android for Work App. The Android for Work App is managed by the DPC.\n- \"unmanagedProfile\"—A device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.",
+                    "description": "Identifies the extent to which the device is controlled by an Android for Work EMM in various deployment configurations.\n\nPossible values include: \n- \"managedDevice\", a device that has the EMM's device policy controller (DPC) as the device owner, \n- \"managedProfile\", a device that has a work profile managed by the DPC (DPC is profile owner) in addition to a separate, personal profile that is unavailable to the DPC, \n- \"containerApp\", a device running the Android for Work App. The Android for Work App is managed by the DPC, \n- \"unmanagedProfile\", a device that has been allowed (by the domain's admin, using the Admin Console to enable the privilege) to use Android for Work apps or Google Apps for Work, but the profile is itself not owned by a DPC.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "DeviceState": {
             "description": "The state of a user's device, as accessed by the getState and setState methods on device resources.",
             "id": "DeviceState",
             "properties": {
                 "accountState": {
@@ skipping 696 matching lines @@
                     "default": "androidenterprise#productSet",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#productSet\".",
                     "type": "string"
                 },
                 "productId": {
                     "description": "The list of product IDs making up the set of products.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
+                },
+                "productSetBehavior": {
+                    "description": "The interpretation of this product set. \"unknown\" should never be sent and ignored if received. \"whitelist\" means that this product set constitutes a whitelist. \"includeAll\" means that all products are accessible (the value of the productId field is therefore ignored). If a value is not supplied, it is interpreted to be \"whitelist\" for backwards compatibility.",
+                    "type": "string"
                 }
             },
             "type": "object"
         },
         "ProductsApproveRequest": {
             "id": "ProductsApproveRequest",
             "properties": {
                 "approvalUrlInfo": {
                     "$ref": "ApprovalUrlInfo",
                     "description": "The approval URL that was shown to the user. Only the permissions shown to the user with that URL will be accepted, which may not be the product's entire set of permissions. For example, the URL may only display new permissions from an update after the product was approved, or not include new permissions if the product was updated since the URL was generated."
@@ skipping 159 matching lines @@
             "id": "StoreLayout",
             "properties": {
                 "homepageId": {
                     "description": "The ID of the store page to be used as the homepage. The homepage will be used as the first page shown in the Google Play for Work store.\n\nIf a homepage has not been set, the Play store shown on devices will be empty. Not specifying a homepage on a store layout effectively empties the store.\n\nIf there exists at least one page, this field must be set to the ID of a valid page.",
                     "type": "string"
                 },
                 "kind": {
                     "default": "androidenterprise#storeLayout",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#storeLayout\".",
                     "type": "string"
+                },
+                "storeLayoutType": {
+                    "description": "Sets a store layout type. By default, this value is set to \"basic\". If set to \"custom\", \"homepageId\" must be specified. If set to \"basic\", the layout will consist of all approved apps accessible by the user, split in pages of 100 each; in this case, \"homepageId\" must not be specified. The \"basic\" setting takes precedence over any existing collections setup for this enterprise (if any). Should the enterprise use collectionViewers for controlling access rights, these will still be respected.",
+                    "type": "string"
                 }
             },
             "type": "object"
         },
         "StoreLayoutClustersListResponse": {
             "description": "The store page resources for the enterprise.",
             "id": "StoreLayoutClustersListResponse",
             "properties": {
                 "cluster": {
                     "description": "A store cluster of an enterprise.",
@@ skipping 154 matching lines @@
                     "type": "array"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "androidenterprise/v1/",
     "title": "Google Play EMM API",
     "version": "v1"
 }