Skip to content
OpenParablePublic APIs

Google Play EMM API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Manages the deployment of apps to Android Enterprise devices.

Google Play EMM API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 76 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://androidenterprise.googleapis.com/
Version
v1
Endpoints
76
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://androidenterprise.googleapis.com/androidenterprise/v1/enterprises" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://androidenterprise.googleapis.com/androidenterprise/v1/enterprises", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://androidenterprise.googleapis.com/androidenterprise/v1/enterprises",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/androidenterprise/v1/enterprisesLooks 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
POST/androidenterprise/v1/enterprises/acknowledgeNotificationSetAcknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
POST/androidenterprise/v1/enterprises/completeSignupCompletes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
POST/androidenterprise/v1/enterprises/enrollEnrolls an enterprise with the calling EMM.
POST/androidenterprise/v1/enterprises/pullNotificationSetPulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if
POST/androidenterprise/v1/enterprises/signupUrlGenerates a sign-up URL.
GET/androidenterprise/v1/enterprises/{enterpriseId}Retrieves the name and domain of an enterprise.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/accountSets the account that will be used to authenticate to the API as the enterprise.
POST/androidenterprise/v1/enterprises/{enterpriseId}/createEnrollmentTokenReturns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device AP
POST/androidenterprise/v1/enterprises/{enterpriseId}/createWebTokenReturns 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 on
GET/androidenterprise/v1/enterprises/{enterpriseId}/groupLicensesRetrieves IDs of all products for which the enterprise has a group license. **Note:** This item has been deprecated. New integrations cannot use this method and
GET/androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}Retrieves details of an enterprise's group license for a product. **Note:** This item has been deprecated. New integrations cannot use this method and can refer
GET/androidenterprise/v1/enterprises/{enterpriseId}/groupLicenses/{groupLicenseId}/usersRetrieves the IDs of the users who have been granted entitlements under the license. **Note:** This item has been deprecated. New integrations cannot use this m
GET/androidenterprise/v1/enterprises/{enterpriseId}/productsFinds approved products that match a query, or all approved products if there is no query. **Note:** This item has been deprecated. New integrations cannot use
GET/androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}Retrieves details of a product for display to an enterprise admin.
GET/androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/appRestrictionsSchemaRetrieves the schema that defines the configurable properties for this product. All products have a schema, but this schema may be empty if no managed configura
POST/androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/approveApproves the specified product and the relevant app permissions, if any. The maximum number of products that you can approve per enterprise customer is 1,000. T
POST/androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/generateApprovalUrlGenerates a URL that can be rendered in an iframe to display the permissions (if any) of a product. An enterprise admin must view these permissions and accept t
GET/androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettingsLists all the managed configurations settings for the specified app.
GET/androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/permissionsRetrieves the Android app permissions required by this app.
POST/androidenterprise/v1/enterprises/{enterpriseId}/products/{productId}/unapproveUnapproves the specified product (and the relevant app permissions, if any) **Note:** This item has been deprecated. New integrations cannot use this method and
POST/androidenterprise/v1/enterprises/{enterpriseId}/sendTestPushNotificationSends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
GET/androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountReturns a service account and credentials. The service account can be bound to the enterprise by calling setAccount. The service account is unique to this enter
GET/androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeysLists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must ha
POST/androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeysGenerates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.G
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/serviceAccountKeys/{keyId}Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved
GET/androidenterprise/v1/enterprises/{enterpriseId}/storeLayoutReturns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/storeLayoutSets 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 ap
GET/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pagesRetrieves the details of all pages in the store.
POST/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pagesInserts a new store page.
GET/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}Retrieves details of a store page.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}Updates the content of a store page.
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}Deletes a store page.
GET/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clustersRetrieves the details of all clusters on the specified page.
POST/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clustersInserts a new cluster in a page.
GET/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}Retrieves details of a cluster.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}Updates a cluster.
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}Deletes a cluster.
POST/androidenterprise/v1/enterprises/{enterpriseId}/unenrollUnenrolls an enterprise from the calling EMM.
GET/androidenterprise/v1/enterprises/{enterpriseId}/usersLooks up a user by 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 i
POST/androidenterprise/v1/enterprises/{enterpriseId}/usersCreates a new EMM-managed user. The Users resource passed in the body of the request should include an accountIdentifier and an accountType. If a corresponding
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}Retrieves a user's details.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in th
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}Deleted an EMM-managed user.
POST/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/authenticationTokenGenerates 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 sin
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSetRetrieves the set of products a user is entitled to access. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to ou
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/availableProductSetModifies the set of products that a user is entitled to access (referred to as *whitelisted* products). Only products that are approved or products that were pr
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/deviceAccessRevokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices.
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devicesRetrieves the IDs of all of a user's devices.
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}Retrieves the details of a device.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}Updates the device policy. To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the allowed_a
POST/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/forceReportUploadUploads a report containing any changes in app states on the device since the last report was generated. You can call this method up to 3 times every 24 hours f
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installsRetrieves the details of all apps installed on the specified device.
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}Retrieves details of an installation of an app on a device.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary.
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}Requests to remove an app from a device. A call to get or list will still show the app as installed on the device until it is actually removed.
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDeviceLists all the per-device managed configurations for the specified device. Only the ID is set.
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}Retrieves details of a per-device managed configuration.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}Adds or updates a per-device managed configuration for an app for the specified device.
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}Removes a per-device managed configuration for an app for the specified device.
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/stateRetrieves 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 i
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/stateSets 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 ena
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlementsLists all entitlements for the specified user. Only the ID is set. **Note:** This item has been deprecated. New integrations cannot use this method and can refe
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}Retrieves details of an entitlement. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}Adds or updates an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new r
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}Removes an entitlement to an app for a user. **Note:** This item has been deprecated. New integrations cannot use this method and can refer to our new recommend
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUserLists all the per-user managed configurations for the specified user. Only the ID is set.
GET/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}Retrieves details of a per-user managed configuration for an app for the specified user.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed co
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}Removes a per-user managed configuration for an app for the specified user.
GET/androidenterprise/v1/enterprises/{enterpriseId}/webAppsRetrieves the details of all web apps for a given enterprise.
POST/androidenterprise/v1/enterprises/{enterpriseId}/webAppsCreates a new web app for the enterprise.
GET/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}Gets an existing web app.
PUT/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}Updates an existing web app.
DELETE/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}Deletes an existing web app.
GET/androidenterprise/v1/permissions/{permissionId}Retrieves details of an Android app permission for display to an enterprise admin.

Questions

Does the Google Play EMM API API need an API key?

Yes. The Google Play EMM API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Google Play EMM API API support HTTPS?

Yes, the Google Play EMM API API is served over HTTPS.

How many endpoints does the Google Play EMM API API have?

Its OpenAPI description lists 76 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Google Play EMM API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).