Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(323)

Unified Diff: discovery/googleapis/androidenterprise__v1.json

Issue 2159673002: Api-roll 39: 2016-07-18 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 4 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/analyticsreporting__v4.json ('k') | discovery/googleapis/androidpublisher__v2.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/androidenterprise__v1.json
diff --git a/discovery/googleapis/androidenterprise__v1.json b/discovery/googleapis/androidenterprise__v1.json
index 9a30980c3dea217a1e865584fbb31c43e7376e54..d1968aa1c7bf7a65255ebc99b5394c7ddff7cf04 100644
--- a/discovery/googleapis/androidenterprise__v1.json
+++ b/discovery/googleapis/androidenterprise__v1.json
@@ -15,7 +15,7 @@
"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/rGtRo1CaRwLtOUwI7c92dFYETcc\"",
+ "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/1RjmJ_qP2oWoO3TZiowI1c1EgE0\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/android-16.png",
"x32": "https://www.google.com/images/icons/product/android-32.png"
@@ -473,7 +473,7 @@
]
},
"getState": {
- "description": "Retrieves whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only 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 access to Google services.",
+ "description": "Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only 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 access to Google services. This is only supported for Google-managed users.",
"httpMethod": "GET",
"id": "androidenterprise.devices.getState",
"parameterOrder": [
@@ -540,7 +540,7 @@
]
},
"setState": {
- "description": "Sets whether a device is enabled or disabled for access by the user to Google services. The device state takes effect only 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 access to Google services.",
+ "description": "Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only 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 access to Google services. This is only supported for Google-managed users.",
"httpMethod": "PUT",
"id": "androidenterprise.devices.setState",
"parameterOrder": [
@@ -583,6 +583,46 @@
},
"enterprises": {
"methods": {
+ "acknowledgeNotificationSet": {
+ "description": "Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.acknowledgeNotificationSet",
+ "parameters": {
+ "notificationSetId": {
+ "description": "The notification set ID as returned by Enterprises.PullNotificationSet. This must be provided.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/acknowledgeNotificationSet",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "completeSignup": {
+ "description": "Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.completeSignup",
+ "parameters": {
+ "completionToken": {
+ "description": "The Completion token initially returned by GenerateSignupUrl.",
+ "location": "query",
+ "type": "string"
+ },
+ "enterpriseToken": {
+ "description": "The Enterprise token appended to the Callback URL.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/completeSignup",
+ "response": {
+ "$ref": "Enterprise"
+ },
+ "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",
@@ -629,6 +669,25 @@
"https://www.googleapis.com/auth/androidenterprise"
]
},
+ "generateSignupUrl": {
+ "description": "Generates a sign-up URL.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.enterprises.generateSignupUrl",
+ "parameters": {
+ "callbackUrl": {
+ "description": "The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named \"enterpriseToken\" which will contain an opaque token to be used for the CompleteSignup request.\nBeware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/signupUrl",
+ "response": {
+ "$ref": "SignupInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
"get": {
"description": "Retrieves the name and domain of an enterprise.",
"httpMethod": "GET",
@@ -652,6 +711,41 @@
"https://www.googleapis.com/auth/androidenterprise"
]
},
+ "getServiceAccount": {
+ "description": "Returns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enterprise and EMM, and will be deleted if the enterprise is unbound. The credentials contain private key data and are not stored server-side.\n\nThis method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.\n\nSubsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.\n\nOnce the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.enterprises.getServiceAccount",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "keyType": {
+ "description": "The type of credential to return with the service account. Required.",
+ "enum": [
+ "googleCredentials",
+ "pkcs12"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccount",
+ "response": {
+ "$ref": "ServiceAccount"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
"getStoreLayout": {
"description": "Returns the store layout resource.",
"httpMethod": "GET",
@@ -702,7 +796,7 @@
]
},
"list": {
- "description": "Looks up an enterprise by domain name.",
+ "description": "Looks up an enterprise by domain name. This is only supported for enterprises created via the Google-initiated creation flow. Lookup of the id is not needed for enterprises created via the EMM-initiated flow since the EMM learns the enterprise ID in the callback specified in the Enterprises.generateSignupUrl call.",
"httpMethod": "GET",
"id": "androidenterprise.enterprises.list",
"parameterOrder": [
@@ -724,6 +818,33 @@
"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.",
+ "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.",
+ "enum": [
+ "returnImmediately",
+ "waitForNotifications"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "enterprises/pullNotificationSet",
+ "response": {
+ "$ref": "NotificationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
"sendTestPushNotification": {
"description": "Sends a test push notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.",
"httpMethod": "POST",
@@ -1527,7 +1648,7 @@
]
},
"list": {
- "description": "Finds approved products that match a query.",
+ "description": "Finds approved products that match a query, or all approved products if there is no query.",
"httpMethod": "GET",
"id": "androidenterprise.products.list",
"parameterOrder": [
@@ -1557,7 +1678,7 @@
"type": "integer"
},
"query": {
- "description": "The search query as typed in the Google Play Store search box. If omitted, all approved apps will be returned (using the pagination parameters).",
+ "description": "The search query as typed in the Google Play Store search box. If omitted, all approved apps will be returned (using the pagination parameters), including apps that are not available in the store (e.g. unpublished apps).",
"location": "query",
"type": "string"
},
@@ -1575,6 +1696,33 @@
"https://www.googleapis.com/auth/androidenterprise"
]
},
+ "unapprove": {
+ "description": "Unapproves the specified product (and the relevant app permissions, if any)",
+ "httpMethod": "POST",
+ "id": "androidenterprise.products.unapprove",
+ "parameterOrder": [
+ "enterpriseId",
+ "productId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "productId": {
+ "description": "The ID of the product.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/products/{productId}/unapprove",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
"updatePermissions": {
"description": "This method has been deprecated. To programmatically approve applications, you must use the iframe mechanism via the generateApprovalUrl and approve methods of the Products resource. For more information, see the Play EMM API usage requirements.\n\nThe updatePermissions method (deprecated) updates the set of Android app permissions for this app that have been accepted by the enterprise.",
"httpMethod": "PUT",
@@ -1610,6 +1758,86 @@
}
}
},
+ "serviceaccountkeys": {
+ "methods": {
+ "delete": {
+ "description": "Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.serviceaccountkeys.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "keyId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "keyId": {
+ "description": "The ID of the key.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccountKeys/{keyId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "insert": {
+ "description": "Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.\n\nOnly the type of the key should be populated in the resource to be inserted.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.serviceaccountkeys.insert",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccountKeys",
+ "request": {
+ "$ref": "ServiceAccountKey"
+ },
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "list": {
+ "description": "Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.",
+ "httpMethod": "GET",
+ "id": "androidenterprise.serviceaccountkeys.list",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/serviceAccountKeys",
+ "response": {
+ "$ref": "ServiceAccountKeysListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ }
+ }
+ },
"storelayoutclusters": {
"methods": {
"delete": {
@@ -2006,6 +2234,63 @@
},
"users": {
"methods": {
+ "delete": {
+ "description": "Deleted an EMM-managed user.",
+ "httpMethod": "DELETE",
+ "id": "androidenterprise.users.delete",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}",
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
+ "generateAuthenticationToken": {
+ "description": "Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.\n\nThis call only works with EMM-managed accounts.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.users.generateAuthenticationToken",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}/authenticationToken",
+ "response": {
+ "$ref": "AuthenticationToken"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
"generateToken": {
"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 accounts.",
"httpMethod": "POST",
@@ -2096,8 +2381,34 @@
"https://www.googleapis.com/auth/androidenterprise"
]
},
+ "insert": {
+ "description": "Creates a new EMM-managed user.\n\nThe required details of the user are passed in the Users resource in the body of the request. Specifically, the accountIdentifier, accountType, and displayName fields must be provided.",
+ "httpMethod": "POST",
+ "id": "androidenterprise.users.insert",
+ "parameterOrder": [
+ "enterpriseId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
"list": {
- "description": "Looks up a user by their primary email address.",
+ "description": "Looks up a user by their primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.",
"httpMethod": "GET",
"id": "androidenterprise.users.list",
"parameterOrder": [
@@ -2126,6 +2437,39 @@
"https://www.googleapis.com/auth/androidenterprise"
]
},
+ "patch": {
+ "description": "Updates the details of an EMM-managed user.\n\nThis only works with EMM-managed users. Pass the new details in Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "id": "androidenterprise.users.patch",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
+ },
"revokeToken": {
"description": "Revokes a previously generated token (activation code) for the user.",
"httpMethod": "DELETE",
@@ -2185,13 +2529,57 @@
"scopes": [
"https://www.googleapis.com/auth/androidenterprise"
]
+ },
+ "update": {
+ "description": "Updates the details of an EMM-managed user.\n\nThis only works with EMM-managed users. Pass the new details in Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.",
+ "httpMethod": "PUT",
+ "id": "androidenterprise.users.update",
+ "parameterOrder": [
+ "enterpriseId",
+ "userId"
+ ],
+ "parameters": {
+ "enterpriseId": {
+ "description": "The ID of the enterprise.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "enterprises/{enterpriseId}/users/{userId}",
+ "request": {
+ "$ref": "User"
+ },
+ "response": {
+ "$ref": "User"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/androidenterprise"
+ ]
}
}
}
},
- "revision": "20160615",
+ "revision": "20160706",
"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"
+ },
"AppRestrictionsSchema": {
"description": "Represents the list of app restrictions available to be pre-configured for the product.",
"id": "AppRestrictionsSchema",
@@ -2211,6 +2599,17 @@
},
"type": "object"
},
+ "AppRestrictionsSchemaChangeEvent": {
+ "description": "An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API.",
+ "id": "AppRestrictionsSchemaChangeEvent",
+ "properties": {
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the app restriction schema changed. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"AppRestrictionsSchemaRestriction": {
"description": "A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied.",
"id": "AppRestrictionsSchemaRestriction",
@@ -2283,6 +2682,17 @@
},
"type": "object"
},
+ "AppUpdateEvent": {
+ "description": "An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API.",
+ "id": "AppUpdateEvent",
+ "properties": {
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") that was updated. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"AppVersion": {
"description": "This represents a single version of the app.",
"id": "AppVersion",
@@ -2315,6 +2725,22 @@
},
"type": "object"
},
+ "AuthenticationToken": {
+ "description": "An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.",
+ "id": "AuthenticationToken",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#authenticationToken",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#authenticationToken\".",
+ "type": "string"
+ },
+ "token": {
+ "description": "The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"Collection": {
"description": "A collection resource defines a named set of apps that is visible to a set of users in the Google Play Store app running on those users' managed devices. Those users can then install any of those apps if they wish (which will trigger creation of install and entitlement resources). A user cannot 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 directly install an app regardless of whether it is in any collection - so an enterprise has a choice of either directly pushing apps to users, or allowing users to install apps if they want. Which is appropriate will depend on the enterprise's policies and the purpose of the apps concerned.",
"id": "Collection",
@@ -2410,7 +2836,7 @@
"type": "string"
},
"managementType": {
- "description": "The mechanism by which this device is managed by the EMM. \"managedDevice\" means that the EMM's app is a device owner. \"managedProfile\" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). \"containerApp\" means that the EMM's app is managing the Android for Work container app on the device. ?unmanagedProfile? means that the EMM?s app is managing a managed user on an unmanaged device",
+ "description": "The mechanism by which this device is managed by the EMM. \"managedDevice\" means that the EMM's app is a device owner. \"managedProfile\" means that the EMM's app is the profile owner (and there is a separate personal profile which is not managed). \"containerApp\" means that the EMM's app is managing the Android for Work container app on the device.",
"type": "string"
}
},
@@ -2452,9 +2878,16 @@
"type": "object"
},
"Enterprise": {
- "description": "An enterprise resource represents a binding between an organization and their EMM.\n\nTo create an enterprise, an admin of the enterprise 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. Until this is done the EMM will not have any access to the enterprise.\n\nAfter calling 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-enrolling an enterprise is possible, but requires a new token to be retrieved. Enterprises.unenroll requires the EMM's credentials (as enroll does), not the enterprise's. Enterprises.unenroll can only be used for enterprises that were previously enrolled with the enroll call. Any enterprises that were enrolled using the (deprecated) 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 enterprise 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.",
+ "description": "An enterprise resource represents the binding between an EMM and a specific organization.\n\n\nThat binding can be instantiated in one of two different ways using this API as follows:\n\n\n \n- For Google managed domain customers, the process involves using Enterprises.enroll and Enterprises.setAccount (in conjunction with artifacts obtained from the Admin console and the Google Developers console) and submitted to the EMM through a more-or-less manual process. \n\n\n- An alternative process that takes advantage of Google-provided mechanisms (Android for Work Sign-up UI) that expedite the process involves Enterprises.generateSignupUrl, Enterprises.completeSignup, Enterprises.getServiceAccount (optional), and Enterprises.setAccount. \n\n\nThe overall processes are very different and involve different identity models, but as an EMM, you can support either or both approaches in your EMM console. See EMM Developer's Guide for details.",
"id": "Enterprise",
"properties": {
+ "administrator": {
+ "description": "Administrators of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.",
+ "items": {
+ "$ref": "Administrator"
+ },
+ "type": "array"
+ },
"id": {
"description": "The unique ID for the enterprise.",
"type": "string"
@@ -2665,6 +3098,33 @@
},
"type": "object"
},
+ "InstallFailureEvent": {
+ "description": "An event generated when an app installation failed on a device",
+ "id": "InstallFailureEvent",
+ "properties": {
+ "deviceId": {
+ "description": "The Android ID of the device. This field will always be present.",
+ "type": "string"
+ },
+ "failureDetails": {
+ "description": "Additional details on the failure if applicable.",
+ "type": "string"
+ },
+ "failureReason": {
+ "description": "The reason for the installation failure. This field will always be present.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the install failure event occured. This field will always be present.",
+ "type": "string"
+ },
+ "userId": {
+ "description": "The ID of the user. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"InstallsListResponse": {
"description": "The install resources for the device.",
"id": "InstallsListResponse",
@@ -2699,6 +3159,94 @@
},
"type": "object"
},
+ "NewPermissionsEvent": {
+ "description": "An event generated when new permissions are added to an app.",
+ "id": "NewPermissionsEvent",
+ "properties": {
+ "approvedPermissions": {
+ "description": "The set of permissions that the enterprise admin has already approved for this application. Use Permissions.Get on the EMM API to retrieve details about these permissions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which new permissions were added. This field will always be present.",
+ "type": "string"
+ },
+ "requestedPermissions": {
+ "description": "The set of permissions that the app is currently requesting. Use Permissions.Get on the EMM API to retrieve details about these permissions.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Notification": {
+ "description": "A notification of one event relating to an enterprise.",
+ "id": "Notification",
+ "properties": {
+ "appRestrictionsSchemaChangeEvent": {
+ "$ref": "AppRestrictionsSchemaChangeEvent",
+ "description": "Notifications about new app restrictions schema changes."
+ },
+ "appUpdateEvent": {
+ "$ref": "AppUpdateEvent",
+ "description": "Notifications about app updates."
+ },
+ "enterpriseId": {
+ "description": "The ID of the enterprise for which the notification is sent. This will always be present.",
+ "type": "string"
+ },
+ "installFailureEvent": {
+ "$ref": "InstallFailureEvent",
+ "description": "Notifications about an app installation failure."
+ },
+ "newPermissionsEvent": {
+ "$ref": "NewPermissionsEvent",
+ "description": "Notifications about new app permissions."
+ },
+ "productApprovalEvent": {
+ "$ref": "ProductApprovalEvent",
+ "description": "Notifications about changes to a product's approval status."
+ },
+ "productAvailabilityChangeEvent": {
+ "$ref": "ProductAvailabilityChangeEvent",
+ "description": "Notifications about product availability changes."
+ },
+ "timestampMillis": {
+ "description": "The time when the notification was published in milliseconds since 1970-01-01T00:00:00Z. This will always be present.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NotificationSet": {
+ "description": "A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request.",
+ "id": "NotificationSet",
+ "properties": {
+ "kind": {
+ "default": "androidenterprise#notificationSet",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#notificationSet\".",
+ "type": "string"
+ },
+ "notification": {
+ "description": "The notifications received, or empty if no notifications are present.",
+ "items": {
+ "$ref": "Notification"
+ },
+ "type": "array"
+ },
+ "notificationSetId": {
+ "description": "The notification set ID, required to mark the notification as received with the Enterprises.AcknowledgeNotification API. This will be omitted if no notifications are present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"PageInfo": {
"id": "PageInfo",
"properties": {
@@ -2742,7 +3290,7 @@
"type": "object"
},
"Product": {
- "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 restricted to a single enterprise, and no information about them is made available outside 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 basic representation of the product within an EMM user interface.",
+ "description": "A Products resource represents an app in the Google Play Store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside 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 basic representation of the product within an EMM user interface.",
"id": "Product",
"properties": {
"appVersion": {
@@ -2778,7 +3326,7 @@
"type": "string"
},
"productPricing": {
- "description": "Whether this product is free, free with in-app purchases, or paid.",
+ "description": "Whether this product is free, free with in-app purchases, or paid. If the pricing is unknown, this means the product is not generally available anymore (even though it might still be available to people who own it).",
"type": "string"
},
"requiresContainerApp": {
@@ -2800,6 +3348,36 @@
},
"type": "object"
},
+ "ProductApprovalEvent": {
+ "description": "An event generated when a product's approval status is changed.",
+ "id": "ProductApprovalEvent",
+ "properties": {
+ "approved": {
+ "description": "Whether the product was approved or unapproved. This field will always be present.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the approval status has changed. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductAvailabilityChangeEvent": {
+ "description": "An event generated whenever a product's availability changes.",
+ "id": "ProductAvailabilityChangeEvent",
+ "properties": {
+ "availabilityStatus": {
+ "description": "The new state of the product. This field will always be present.",
+ "type": "string"
+ },
+ "productId": {
+ "description": "The id of the product (e.g. \"app:com.google.android.gm\") for which the product availability changed. This field will always be present.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"ProductPermission": {
"description": "A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted 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.",
"id": "ProductPermission",
@@ -2909,6 +3487,88 @@
},
"type": "object"
},
+ "ServiceAccount": {
+ "description": "A service account identity, including the name and credentials that can be used to authenticate as the service account.",
+ "id": "ServiceAccount",
+ "properties": {
+ "key": {
+ "$ref": "ServiceAccountKey",
+ "description": "Credentials that can be used to authenticate as this ServiceAccount."
+ },
+ "kind": {
+ "default": "androidenterprise#serviceAccount",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccount\".",
+ "type": "string"
+ },
+ "name": {
+ "description": "The account name of the service account, in the form of an email address. Assigned by the server.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ServiceAccountKey": {
+ "description": "Credentials that can be used to authenticate as a service account.",
+ "id": "ServiceAccountKey",
+ "properties": {
+ "data": {
+ "description": "The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.",
+ "type": "string"
+ },
+ "id": {
+ "description": "An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#serviceAccountKey",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#serviceAccountKey\".",
+ "type": "string"
+ },
+ "type": {
+ "annotations": {
+ "required": [
+ "androidenterprise.serviceaccountkeys.insert"
+ ]
+ },
+ "description": "The file format of the generated key data.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ServiceAccountKeysListResponse": {
+ "id": "ServiceAccountKeysListResponse",
+ "properties": {
+ "serviceAccountKey": {
+ "description": "The service account credentials.",
+ "items": {
+ "$ref": "ServiceAccountKey"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SignupInfo": {
+ "description": "A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token.",
+ "id": "SignupInfo",
+ "properties": {
+ "completionToken": {
+ "description": "An opaque token that will be required, along with the Enterprise Token, for obtaining the enterprise resource from CompleteSignup.",
+ "type": "string"
+ },
+ "kind": {
+ "default": "androidenterprise#signupInfo",
+ "description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#signupInfo\".",
+ "type": "string"
+ },
+ "url": {
+ "description": "A URL under which the Admin can sign up for an enterprise. The page pointed to cannot be rendered in an iframe.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"StoreCluster": {
"description": "Definition of a Google Play for Work store cluster, a list of products displayed as part of a store page.",
"id": "StoreCluster",
@@ -3040,9 +3700,31 @@
"type": "object"
},
"User": {
- "description": "A user resource represents an individual user within the enterprise's domain.\n\nNote that each user is associated with a Google account based on the user's corporate email address (which must be in one of the enterprise'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 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 method queried by the user's primary email address.",
+ "description": "A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to Google Play for Work only, or to other Google services, depending on the identity model used: \n- Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). \n\n\n- Android for Work accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to Google Play for Work only.",
"id": "User",
"properties": {
+ "accountIdentifier": {
+ "annotations": {
+ "required": [
+ "androidenterprise.users.insert"
+ ]
+ },
+ "description": "The id as used by the EMM for this user, e.g. \"user342\" or \"asset#44418\". Will always be set for EMM managed users and not set for Google managed users. For privacy sensitive deployments it should not be possible to identify the individual with this identifier.",
+ "type": "string"
+ },
+ "accountType": {
+ "annotations": {
+ "required": [
+ "androidenterprise.users.insert"
+ ]
+ },
+ "description": "The type of account that this user represents. A \"deviceAccount\" is specific to a single device while a \"userAccount\" represents a traditional user account, i.e. one that can be installed on multiple devices. \"googleManaged\" users will always be a \"userAccount\" but \"emmManaged\" users can be either a \"userAccount\" or a \"deviceAccount\".",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The user's name as it is to be presented in user interfaces, e.g. \"John\". Can optionally be set for EMM managed users and will not be set for Google managed users. For privacy sensitive deployments this should be left unset or set to something generic.",
+ "type": "string"
+ },
"id": {
"description": "The unique ID for the user.",
"type": "string"
@@ -3052,8 +3734,12 @@
"description": "Identifies what kind of resource this is. Value: the fixed string \"androidenterprise#user\".",
"type": "string"
},
+ "managementType": {
+ "description": "The entity that manages the user. With \"googleManaged\" users, the source of truth is Google so EMMs have to make sure a Google account exists for the user. With \"emmManaged\" users, the EMM is in charge.",
+ "type": "string"
+ },
"primaryEmail": {
- "description": "The user's primary email address, e.g. \"jsmith@example.com\".",
+ "description": "The user's primary email address, for example, \"jsmith@example.com\". Will always be set for Google managed users and not set for EMM managed users.",
"type": "string"
}
},
« no previous file with comments | « discovery/googleapis/analyticsreporting__v4.json ('k') | discovery/googleapis/androidpublisher__v2.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698