googleapis.com – androidenterprise
Manages the deployment of apps to Android Enterprise devices.
- Homepage
- https://api.apis.guru/v2/specs/googleapis.com:androidenterprise/v1.json
- Provider
- googleapis.com:androidenterprise / androidenterprise
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/googleapis.com/androidenterprise/v1/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/googleapis.com/androidenterprise/v1/openapi.yaml
Tools (78)
Extracted live via the executor SDK.
-
devices.androidenterpriseDevicesForceReportUploadUploads 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. If you exceed the quota, then the Google Play EMM API returns HTTP 429 Too Many Requests.
-
devices.androidenterpriseDevicesGetRetrieves the details of a device.
-
devices.androidenterpriseDevicesGetStateRetrieves 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.
-
devices.androidenterpriseDevicesListRetrieves the IDs of all of a user's devices.
-
devices.androidenterpriseDevicesSetStateSets 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.
-
devices.androidenterpriseDevicesUpdateUpdates the device policy. 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. When provisioning a new device, you should set the device policy using this method before adding the managed Google Play Account to the device, otherwise the policy will not be applied for a short period of time after adding the account to the device.
-
enterprises.androidenterpriseEnterprisesAcknowledgeNotificationSetAcknowledges notifications that were received from Enterprises.PullNotificationSet to prevent subsequent calls from returning the same notifications.
-
enterprises.androidenterpriseEnterprisesCompleteSignupCompletes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
-
enterprises.androidenterpriseEnterprisesCreateEnrollmentTokenReturns 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 API to authenticate the user. The token can be generated for each device or reused across multiple devices.
-
enterprises.androidenterpriseEnterprisesCreateWebTokenReturns 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.
-
enterprises.androidenterpriseEnterprisesEnrollEnrolls an enterprise with the calling EMM.
-
enterprises.androidenterpriseEnterprisesGenerateSignupUrlGenerates a sign-up URL.
-
enterprises.androidenterpriseEnterprisesGetRetrieves the name and domain of an enterprise.
-
enterprises.androidenterpriseEnterprisesGetServiceAccountReturns 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.
-
enterprises.androidenterpriseEnterprisesGetStoreLayoutReturns the store layout for the enterprise. If the store layout has not been set, returns "basic" as the store layout type and no homepage.
-
enterprises.androidenterpriseEnterprisesListLooks 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.
-
enterprises.androidenterpriseEnterprisesPullNotificationSetPulls 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.
-
enterprises.androidenterpriseEnterprisesSendTestPushNotificationSends a test notification to validate the EMM integration with the Google Cloud Pub/Sub service for this enterprise.
-
enterprises.androidenterpriseEnterprisesSetAccountSets the account that will be used to authenticate to the API as the enterprise.
-
enterprises.androidenterpriseEnterprisesSetStoreLayoutSets 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.
-
enterprises.androidenterpriseEnterprisesUnenrollUnenrolls an enterprise from the calling EMM.
-
entitlements.androidenterpriseEntitlementsDeleteRemoves 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 recommendations.
-
entitlements.androidenterpriseEntitlementsGetRetrieves details of an entitlement. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
-
entitlements.androidenterpriseEntitlementsListLists 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 refer to our new recommendations.
-
entitlements.androidenterpriseEntitlementsUpdateAdds 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 recommendations.
-
grouplicenses.androidenterpriseGrouplicensesGetRetrieves 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 to our new recommendations.
-
grouplicenses.androidenterpriseGrouplicensesListRetrieves 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 can refer to our new recommendations.
-
grouplicenseusers.androidenterpriseGrouplicenseusersListRetrieves the IDs of the users who have been granted entitlements under the license. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
-
installs.androidenterpriseInstallsDeleteRequests 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.
-
installs.androidenterpriseInstallsGetRetrieves details of an installation of an app on a device.
-
installs.androidenterpriseInstallsListRetrieves the details of all apps installed on the specified device.
-
installs.androidenterpriseInstallsUpdateRequests 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.androidenterpriseManagedconfigurationsfordeviceDeleteRemoves a per-device managed configuration for an app for the specified device.
-
managedconfigurationsfordevice.androidenterpriseManagedconfigurationsfordeviceGetRetrieves details of a per-device managed configuration.
-
managedconfigurationsfordevice.androidenterpriseManagedconfigurationsfordeviceListLists all the per-device managed configurations for the specified device. Only the ID is set.
-
managedconfigurationsfordevice.androidenterpriseManagedconfigurationsfordeviceUpdateAdds or updates a per-device managed configuration for an app for the specified device.
-
managedconfigurationsforuser.androidenterpriseManagedconfigurationsforuserDeleteRemoves a per-user managed configuration for an app for the specified user.
-
managedconfigurationsforuser.androidenterpriseManagedconfigurationsforuserGetRetrieves details of a per-user managed configuration for an app for the specified user.
-
managedconfigurationsforuser.androidenterpriseManagedconfigurationsforuserListLists all the per-user managed configurations for the specified user. Only the ID is set.
-
managedconfigurationsforuser.androidenterpriseManagedconfigurationsforuserUpdateAdds 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.androidenterpriseManagedconfigurationssettingsListLists all the managed configurations settings for the specified app.
-
permissions.androidenterprisePermissionsGetRetrieves details of an Android app permission for display to an enterprise admin.
-
products.androidenterpriseProductsApproveApproves 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. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
-
products.androidenterpriseProductsGenerateApprovalUrlGenerates 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 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. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
-
products.androidenterpriseProductsGetRetrieves details of a product for display to an enterprise admin.
-
products.androidenterpriseProductsGetAppRestrictionsSchemaRetrieves 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.
-
products.androidenterpriseProductsGetPermissionsRetrieves the Android app permissions required by this app.
-
products.androidenterpriseProductsListFinds 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 this method and can refer to our new recommendations.
-
products.androidenterpriseProductsUnapproveUnapproves the specified product (and the relevant app permissions, if any) Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
-
serviceaccountkeys.androidenterpriseServiceaccountkeysDeleteRemoves 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.
-
serviceaccountkeys.androidenterpriseServiceaccountkeysInsertGenerates 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.
-
serviceaccountkeys.androidenterpriseServiceaccountkeysListLists 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.androidenterpriseStorelayoutclustersDeleteDeletes a cluster.
-
storelayoutclusters.androidenterpriseStorelayoutclustersGetRetrieves details of a cluster.
-
storelayoutclusters.androidenterpriseStorelayoutclustersInsertInserts a new cluster in a page.
-
storelayoutclusters.androidenterpriseStorelayoutclustersListRetrieves the details of all clusters on the specified page.
-
storelayoutclusters.androidenterpriseStorelayoutclustersUpdateUpdates a cluster.
-
storelayoutpages.androidenterpriseStorelayoutpagesDeleteDeletes a store page.
-
storelayoutpages.androidenterpriseStorelayoutpagesGetRetrieves details of a store page.
-
storelayoutpages.androidenterpriseStorelayoutpagesInsertInserts a new store page.
-
storelayoutpages.androidenterpriseStorelayoutpagesListRetrieves the details of all pages in the store.
-
storelayoutpages.androidenterpriseStorelayoutpagesUpdateUpdates the content of a store page.
-
users.androidenterpriseUsersDeleteDeleted an EMM-managed user.
-
users.androidenterpriseUsersGenerateAuthenticationTokenGenerates 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.
-
users.androidenterpriseUsersGetRetrieves a user's details.
-
users.androidenterpriseUsersGetAvailableProductSetRetrieves 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 our new recommendations.
-
users.androidenterpriseUsersInsertCreates 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 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.
-
users.androidenterpriseUsersListLooks 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.
-
users.androidenterpriseUsersRevokeDeviceAccessRevokes 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.
-
users.androidenterpriseUsersSetAvailableProductSetModifies 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. Note: This item has been deprecated. New integrations cannot use this method and can refer to our new recommendations.
-
users.androidenterpriseUsersUpdateUpdates 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 displayName field can be changed. Other fields must either be unset or have the currently active value.
-
webapps.androidenterpriseWebappsDeleteDeletes an existing web app.
-
webapps.androidenterpriseWebappsGetGets an existing web app.
-
webapps.androidenterpriseWebappsInsertCreates a new web app for the enterprise.
-
webapps.androidenterpriseWebappsListRetrieves the details of all web apps for a given enterprise.
-
webapps.androidenterpriseWebappsUpdateUpdates an existing web app.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools