google_api_android_enterprise v0.0.1 API Reference
Modules
API calls for all endpoints tagged Devices
API calls for all endpoints tagged Enterprises
API calls for all endpoints tagged Entitlements
API calls for all endpoints tagged Grouplicenses
API calls for all endpoints tagged Grouplicenseusers
API calls for all endpoints tagged Installs
API calls for all endpoints tagged Managedconfigurationsfordevice
API calls for all endpoints tagged Managedconfigurationsforuser
API calls for all endpoints tagged Permissions
API calls for all endpoints tagged Products
API calls for all endpoints tagged Serviceaccountkeys
API calls for all endpoints tagged Storelayoutclusters
API calls for all endpoints tagged Storelayoutpages
API calls for all endpoints tagged Users
Handle Tesla connections for GoogleApi.AndroidEnterprise.V1
Helper functions for deserializing responses into models
This represents an enterprise admin who can manage the enterprise in the managed Google Play store
A token authorizing an admin to access an iframe
Specification for a token used to generate iframes. The token specifies what data the admin is allowed to modify and the URI the iframe is allowed to communiate with
The Android Device Policy configuration of an enterprise
Represents the list of app restrictions available to be pre-configured for the product
An event generated when a new app version is uploaded to Google Play and its app restrictions schema changed. To fetch the app restrictions schema for an app, use Products.getAppRestrictionsSchema on the EMM API
A restriction in the App Restriction Schema represents a piece of configuration that may be pre-applied
A typed value for the restriction
An event generated when a new version of an app is uploaded to Google Play. Notifications are sent for new public versions only: alpha, beta, or canary versions do not generate this event. To fetch up-to-date version history for an app, use Products.Get on the EMM API
This represents a single version of the app
Information on an approval URL
An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device
A Devices resource represents a mobile device managed by the EMM and belonging to a specific enterprise user. This collection cannot be modified via the API. It is automatically populated as devices are set up to be managed
The state of a user's device, as accessed by the getState and setState methods on device resources
The device resources for the user
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
A service account that can be used to authenticate as the enterprise to API calls that require such authentication
The matching enterprise resources
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
The entitlement resources for the user
A group license object indicates a product that an enterprise admin has approved for use in the enterprise. The product may be free or paid. For free products, a group license object is created in these cases: if the enterprise admin approves a product in Google Play, if the product is added to a collection, or if an entitlement for the product is created for a user via the API. For paid products, a group license object is only created as part of the first bulk purchase of that product in Google Play by the enterprise admin. The API can be used to query group licenses; the available information includes the total number of licenses purchased (for paid products) and the total number of licenses that have been provisioned, that is, the total number of user entitlements in existence for the product. Group license objects are never deleted. If, for example, a free app is added to a collection and then removed, the group license will remain, allowing the enterprise admin to keep track of any remaining entitlements. An enterprise admin may indicate they are no longer interested in the group license by marking it as unapproved in Google Play
The user resources for the group license
The grouplicense resources for the enterprise
The existence of an Installs resource indicates that an app is installed on a particular device (or that an install is pending). The API can be used to create an install resource using the update method. This triggers the actual install of the app on the device. If the user does not already have an entitlement for the app, then an attempt is made to create one. If this fails (for example, because the app is not free and there is no available license), then the creation of the install fails. The API can also be used to update an installed app. If the update method is used on an existing install, then the app will be updated to the latest available version. Note that it is not possible to force the installation of a specific version of an app: the version code is read-only. If a user installs an app themselves (as permitted by the enterprise), then again an install resource and possibly an entitlement resource are automatically created. The API can also be used to delete an install resource, which triggers the removal of the app from the device. Note that deleting an install does not automatically remove the corresponding entitlement, even if there are no remaining installs. The install resource will also be deleted if the user uninstalls the app themselves
An event generated when an app installation failed on a device
The install resources for the device
A localized string with its locale
A managed configuration resource contains the set of managed properties that have been configured for an Android app. The app's developer would have defined configurable properties in the managed configurations schema
The managed configuration resources for the device
The managed configuration resources for the user
A managed property of a managed configuration. The property must match one of the properties in the app restrictions schema of the product. Exactly one of the value fields must be populated, and it must match the property's type in the app restrictions schema
A bundle of managed properties
An event generated when a new device is ready to be managed
An event generated when new permissions are added to an app
A notification of one event relating to an enterprise
A resource returned by the PullNotificationSet API, which contains a collection of notifications for enterprises associated with the service account authenticated for the request
A Permissions resource represents some extra capability, to be granted to an Android app, which requires explicit consent. An enterprise admin must consent to these permissions on behalf of their users before an entitlement for the app can be created. The permissions collection is read-only. The information provided for each permission (localized name and description) is intended to be used in the MDM user interface when obtaining consent from the enterprise
A Products resource represents an app in the Google Play store that is available to at least some users in the enterprise. (Some apps are restricted to a single enterprise, and no information about them is made available outside that enterprise.) The information provided for each product (localized name, icon, link to the full Google Play details page) is intended to allow a basic representation of the product within an EMM user interface
An event generated when a product's approval status is changed
An event generated whenever a product's availability changes
A product permissions resource represents the set of permissions required by a specific app and whether or not they have been accepted by an enterprise admin. The API can be used to read the set of permissions, and also to update the set to indicate that permissions have been accepted
Information about the permissions required by a specific app and whether they have been accepted by the enterprise
A set of products
The matching products
A service account identity, including the name and credentials that can be used to authenticate as the service account
Credentials that can be used to authenticate as a service account
A resource returned by the GenerateSignupUrl API, which contains the Signup URL and Completion Token
Definition of a managed Google Play store cluster, a list of products displayed as part of a store page
General setting for the managed Google Play store layout, currently only specifying the page to display the first time the store is opened
The store page resources for the enterprise
The store page resources for the enterprise
Definition of a managed Google Play store page, made of a localized name and links to other pages. A page also contains clusters defined as a subcollection
A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model: - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail). - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play
A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded
The matching user resources
Helper functions for building Tesla requests