This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.
Resource types
- Devices
- Enterprises
- Entitlements
- Grouplicenses
- Grouplicenseusers
- Installs
- Managedconfigurationsfordevice
- Managedconfigurationsforuser
- Managedconfigurationssettings
- Permissions
- Products
- Serviceaccountkeys
- Storelayoutclusters
- Storelayoutpages
- Users
- Webapps
Devices
For Devices Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
POST /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/forceReportUpload
Uploads 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 for a given device.
GET /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
Retrieves the details of a device.
GET /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/state
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.
GET /enterprises/ enterpriseId
/users/ userId
/devices
Retrieves the IDs of all of a user's devices.
PUT /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/state
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.
PUT /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
To ensure the policy is properly enforced, you need to prevent unmanaged accounts from accessing Google Play by setting the
allowed_accounts
in the managed configuration for the Google
Play package. See restrict
accounts in Google Play
.Enterprises
For Enterprises Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
POST /enterprises/acknowledgeNotificationSet
Acknowledges notifications that were received from
Enterprises.PullNotificationSet to prevent subsequent calls from returning
the same notifications.
POST /enterprises/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.
POST /enterprises/ enterpriseId
/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.
POST /enterprises/enroll
Enrolls an enterprise with the calling EMM.
Required query parameters:
token
POST /enterprises/ enterpriseId
/generateEnterpriseUpgradeUrl
Generates an enterprise upgrade URL to upgrade an existing managed Google
Play Accounts enterprise to a managed Google domain.
See the guide to upgrading an enterprise
for more details.
GET /enterprises/ enterpriseId
/serviceAccount
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.
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.
.
GET /enterprises/ enterpriseId
/storeLayout
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.
GET /enterprises
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.
Required query parameters:
domain
POST /enterprises/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.
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.
POST /enterprises/ enterpriseId
/sendTestPushNotification
Sends a test notification to validate the EMM integration with
the Google Cloud Pub/Sub service for this enterprise.
PUT /enterprises/ enterpriseId
/account
Sets the account that will be used to authenticate to the API as the
enterprise.
PUT /enterprises/ enterpriseId
/storeLayout
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.
Entitlements
For Entitlements Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
DELETE /enterprises/ enterpriseId
/users/ userId
/entitlements/ entitlementId
Removes an entitlement to an app for a user.
GET /enterprises/ enterpriseId
/users/ userId
/entitlements/ entitlementId
Retrieves details of an entitlement.
GET /enterprises/ enterpriseId
/users/ userId
/entitlements
Lists all entitlements for the specified user. Only the ID is set.
PUT /enterprises/ enterpriseId
/users/ userId
/entitlements/ entitlementId
Adds or updates an entitlement to an app for a user.
Grouplicenses
For Grouplicenses Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
GET /enterprises/ enterpriseId
/groupLicenses/ groupLicenseId
Retrieves details of an enterprise's group license for a product.
GET /enterprises/ enterpriseId
/groupLicenses
Retrieves IDs of all products for which the enterprise has a group license.
Grouplicenseusers
For Grouplicenseusers Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
GET /enterprises/ enterpriseId
/groupLicenses/ groupLicenseId
/users
Retrieves the IDs of the users who have been granted entitlements
under the license.
Installs
For Installs Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
DELETE /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 /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/installs/ installId
Retrieves details of an installation of an app on a device.
GET /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/installs
Retrieves the details of all apps installed on the specified device.
PUT /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.
Managedconfigurationsfordevice
For Managedconfigurationsfordevice Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
DELETE /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/managedConfigurationsForDevice/ managedConfigurationForDeviceId
Removes a per-device managed configuration for an app for the specified
device.
GET /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/managedConfigurationsForDevice/ managedConfigurationForDeviceId
Retrieves details of a per-device managed configuration.
GET /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/managedConfigurationsForDevice
Lists all the per-device managed configurations for the specified device.
Only the ID is set.
PUT /enterprises/ enterpriseId
/users/ userId
/devices/ deviceId
/managedConfigurationsForDevice/ managedConfigurationForDeviceId
Adds or updates a per-device managed configuration for an app for the
specified device.
Managedconfigurationsforuser
For Managedconfigurationsforuser Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
DELETE /enterprises/ enterpriseId
/users/ userId
/managedConfigurationsForUser/ managedConfigurationForUserId
Removes a per-user managed configuration for an app for the specified
user.
GET /enterprises/ enterpriseId
/users/ userId
/managedConfigurationsForUser/ managedConfigurationForUserId
Retrieves details of a per-user managed configuration for an app for the
specified user.
GET /enterprises/ enterpriseId
/users/ userId
/managedConfigurationsForUser
Lists all the per-user managed configurations for the specified user. Only
the ID is set.
PUT /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 configurations to a user by specifying an
mcmId
and its associated configuration variables (if any) in the request. Alternatively,
all EMMs can apply managed configurations by passing a list of managed
properties.Managedconfigurationssettings
For Managedconfigurationssettings Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
GET /enterprises/ enterpriseId
/products/ productId
/managedConfigurationsSettings
Lists all the managed configurations settings for the specified app.
Permissions
For Permissions Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
GET /permissions/ permissionId
Retrieves details of an Android app permission for display to an enterprise admin.
Products
For Products Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
POST /enterprises/ enterpriseId
/products/ productId
/approve
Approves 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.
To learn how to use managed Google Play to design and create a store layout to display approved products to your users, see Store Layout Design .
POST /enterprises/ enterpriseId
/products/ productId
/generateApprovalUrl
Generates 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 them on behalf of their organization in order to
approve that product.
Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the
Admins should accept the displayed permissions by interacting with a separate UI element in the EMM console, which in turn should trigger the use of this URL as the
approvalUrlInfo.approvalUrl
property in a Products.approve
call to approve the product.
This URL can only be used to display permissions for up to 1 day.GET /enterprises/ enterpriseId
/products/ productId
Retrieves details of a product for display to an enterprise admin.
GET /enterprises/ enterpriseId
/products/ productId
/appRestrictionsSchema
Retrieves the schema that defines the configurable properties for this
product. All products have a schema, but this schema may be empty if no
managed configurations have been defined. This schema can be used to
populate a UI that allows an admin to configure the product.
To apply a managed configuration based on the schema obtained using this
API, see Managed Configurations through Play
.
GET /enterprises/ enterpriseId
/products/ productId
/permissions
Retrieves the Android app permissions required by this app.
GET /enterprises/ enterpriseId
/products
Finds approved products that match a query, or all approved products
if there is no query.
POST /enterprises/ enterpriseId
/products/ productId
/unapprove
Unapproves the specified product (and the relevant app permissions, if any)
Serviceaccountkeys
For Serviceaccountkeys Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
DELETE /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 by calling Enterprises.GetServiceAccount and must have been set
as the enterprise service account by calling Enterprises.SetAccount.
POST /enterprises/ enterpriseId
/serviceAccountKeys
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.
Only the type of the key should be populated in the resource to be inserted.
Only the type of the key should be populated in the resource to be inserted.
GET /enterprises/ enterpriseId
/serviceAccountKeys
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.
Storelayoutclusters
For Storelayoutclusters Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
DELETE /enterprises/ enterpriseId
/storeLayout/pages/ pageId
/clusters/ clusterId
Deletes a cluster.
GET /enterprises/ enterpriseId
/storeLayout/pages/ pageId
/clusters/ clusterId
Retrieves details of a cluster.
POST /enterprises/ enterpriseId
/storeLayout/pages/ pageId
/clusters
Inserts a new cluster in a page.
GET /enterprises/ enterpriseId
/storeLayout/pages/ pageId
/clusters
Retrieves the details of all clusters on the specified page.
PUT /enterprises/ enterpriseId
/storeLayout/pages/ pageId
/clusters/ clusterId
Updates a cluster.
Storelayoutpages
For Storelayoutpages Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
GET /enterprises/ enterpriseId
/storeLayout/pages
Retrieves the details of all pages in the store.
PUT /enterprises/ enterpriseId
/storeLayout/pages/ pageId
Updates the content of a store page.
Users
For Users Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
POST /enterprises/ enterpriseId
/users/ userId
/authenticationToken
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.
You can provision a maximum of 10 devices per user.
This call only works with EMM-managed accounts.
You can provision a maximum of 10 devices per user.
This call only works with EMM-managed accounts.
GET /enterprises/ enterpriseId
/users/ userId
/availableProductSet
Retrieves the set of products a user is entitled to access.
POST /enterprises/ enterpriseId
/users
Creates a new EMM-managed user.
The Users resource passed in the body of the request should include an
The Users resource passed in the body of the request should include an
accountIdentifier
and an accountType
. If 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.
GET /enterprises/ enterpriseId
/users
Looks 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 is already returned in the
result of the Users.insert call.
Required query parameters:
email
DELETE /enterprises/ enterpriseId
/users/ userId
/deviceAccess
Revokes 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.
This call only works with EMM-managed accounts.
This call only works with EMM-managed accounts.
PUT /enterprises/ enterpriseId
/users/ userId
/availableProductSet
Modifies 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 previously approved (products with revoked approval)
can be whitelisted.
PUT /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 the request body. Only the
Can be used with EMM-managed users only (not Google managed users). Pass the new details in the 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.Webapps
For Webapps Resource details, see the resource representation page.
Method
HTTP request
Description
URIs relative to https://www.googleapis.com/androidenterprise/v1, unless otherwise noted
GET /enterprises/ enterpriseId
/webApps
Retrieves the details of all web apps for a given enterprise.
