Important: We are no longer accepting new registrations for the Play EMM API. Learn more.

Enterprises

For a list of methods for this resource, see the end of this page.

Resource representations

An Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:

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 API Console) and submitted to the EMM through a more-or-less manual process.
For managed Google Play Accounts customers, the process involves using Enterprises.generateSignupUrl and Enterprises.completeSignup in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps.

As an EMM, you can support either or both approaches in your EMM console. See Create an Enterprise for details.

{
  "kind": "androidenterprise#enterprise",
  "id": string,
  "primaryDomain": string,
  "name": string,
  "administrator": [
    {
      "email": string
    }
  ]
}

Property name	Value	Description
`administrator[]`	`list`	Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow.
`administrator[].email`	`string`	The admin's email address.
`id`	`string`	The unique ID for the enterprise.
`kind`	`string`
`name`	`string`	The name of the enterprise, for example, "Example, Inc".
`primaryDomain`	`string`	The enterprise's primary domain, such as "example.com".

Methods

acknowledgeNotificationSet: Acknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
completeSignup: 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.
createWebToken: Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the JavaScript API documentation for further information.
enroll: Enrolls an enterprise with the calling EMM.
generateSignupUrl: Generates a sign-up URL.
get: Retrieves the name and domain of an enterprise.
getServiceAccount: 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.

This method can only be called after calling Enterprises.Enroll or Enterprises.CompleteSignup, and before Enterprises.SetAccount; at other times it will return an error.

Subsequent calls after the first will generate a new, unique set of credentials, and invalidate the previously generated credentials.

Once the service account is bound to the enterprise, it can be managed using the serviceAccountKeys resource.
getStoreLayout: Returns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.
list: 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.
pullNotificationSet: 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.
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.
sendTestPushNotification: Sends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
setAccount: Sets the account that will be used to authenticate to the API as the enterprise.
setStoreLayout: 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 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.
unenroll: Unenrolls an enterprise from the calling EMM.