Entitlements

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

Resource representations

The presence of an Entitlements resource indicates that a user has the right to use a particular app. Entitlements are user specific, not device specific. This allows a user with an entitlement to an app to install the app on all their devices. It's also possible for a user to hold an entitlement to an app without installing the app on any device.

The API can be used to create an entitlement. As an option, you can also use the API to trigger the installation of an app on all a user's managed devices at the same time the entitlement is created.

If the app is free, creating the entitlement also creates a group license for that app. For paid apps, creating the entitlement consumes one license, and that license remains consumed until the entitlement is removed. If the enterprise hasn't purchased enough licenses, then no entitlement is created and the installation fails. An entitlement is also not created for an app if the app requires permissions that the enterprise hasn't accepted.

If an entitlement is deleted, the app may be uninstalled from a user's device. As a best practice, uninstall the app by calling Installs.delete() before deleting the entitlement.

Entitlements for apps that a user pays for on an unmanaged profile have "userPurchase" as the entitlement reason. These entitlements cannot be removed via the API.

{
  "kind": "androidenterprise#entitlement",
  "productId": string,
  "reason": string
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "androidenterprise#entitlement".
productId string The ID of the product that the entitlement is for. For example, "app:com.google.android.gm".
reason string The reason for the entitlement. For example, "free" for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses.

Acceptable values are:
  • "free"
  • "groupLicense"
  • "userPurchase"

Methods

delete
Removes an entitlement to an app for a user.
get
Retrieves details of an entitlement.
list
Lists all entitlements for the specified user. Only the ID is set.
patch
Adds or updates an entitlement to an app for a user. This method supports patch semantics.
update
Adds or updates an entitlement to an app for a user.