Skip to main content

enterprises

Overview

Nameenterprises
TypeResource
Idgoogledevelopers.androidenterprise.enterprises

Fields

NameDatatypeDescription
idstringThe unique ID for the enterprise.
namestringThe name of the enterprise, for example, "Example, Inc".
googleAuthenticationSettingsobjectContains settings for Google-provided user authentication.
primaryDomainstringThe enterprise's primary domain, such as "example.com".
administratorarrayAdmins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.

Methods

NameAccessible byRequired ParamsDescription
getSELECTenterpriseIdRetrieves the name and domain of an enterprise.
listSELECTdomainLooks 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.
acknowledgeNotificationSetEXECAcknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
completeSignupEXECCompletes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
enrollEXECtokenEnrolls an enterprise with the calling EMM.
generateSignupUrlEXECGenerates a sign-up URL.
pullNotificationSetEXECPulls 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. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications 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. Multiple 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. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available.
sendTestPushNotificationEXECenterpriseIdSends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
setAccountEXECenterpriseIdSets the account that will be used to authenticate to the API as the enterprise.
setStoreLayoutEXECenterpriseIdSets 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 admin, 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" and setting a homepage), the basic store layout is disabled.
unenrollEXECenterpriseIdUnenrolls an enterprise from the calling EMM.