API Reference

Cette documentation de référence de l'API est organisée par type de ressource. Chaque type de ressource comporte une ou plusieurs représentations de données, ainsi qu'une ou plusieurs méthodes.

Types de ressources

  1. Appareils
  2. Entreprises
  3. Droits d'accès
  4. Grouplicenses
  5. Grouplicenseusers
  6. Installations
  7. Managedconfigurationsfordevice
  8. Managedconfigurationsforuser
  9. Managedconfigurationssettings
  10. Autorisations
  11. Produits
  12. Clés de compte de service
  13. StorelayoutClusters
  14. Storelayoutpages
  15. Utilisateurs
  16. Applications Web

Appareils

Pour en savoir plus sur la ressource "Appareils", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Importe un rapport contenant les modifications apportées aux états de l'application sur l'appareil depuis la génération du dernier rapport. Vous pouvez appeler cette méthode jusqu'à trois fois toutes les 24 heures pour un appareil donné.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId Récupère les détails d'un appareil.
getState GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state Détermine si l'accès d'un appareil aux services Google est activé ou désactivé. L'état de l'appareil ne prend effet que si l'application des règles EMM sur les appareils Android est activée dans la console d'administration Google. Sinon, l'état de l'appareil est ignoré, et tous les appareils sont autorisés à accéder aux services Google. Cette option n'est disponible que pour les utilisateurs gérés par Google.
liste GET  /enterprises/enterpriseId/users/userId/devices Récupère les identifiants de tous les appareils d'un utilisateur.
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state Détermine si l'accès d'un appareil aux services Google est activé ou désactivé. L'état de l'appareil ne prend effet que si l'application des règles EMM sur les appareils Android est activée dans la console d'administration Google. Sinon, l'état de l'appareil est ignoré, et tous les appareils sont autorisés à accéder aux services Google. Cette option n'est disponible que pour les utilisateurs gérés par Google.
mise à jour PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Met à jour les règles relatives aux appareils.

Pour vous assurer que la règle est correctement appliquée, vous devez empêcher les comptes non gérés d'accéder à Google Play en définissant allowed_accounts dans la configuration gérée du package Google Play. Consultez la section Limiter les comptes dans Google Play.

Entreprises

Pour en savoir plus sur la ressource "Enterprises", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Accepte les notifications reçues d'Enterprises.PullNotificationSet pour empêcher les appels ultérieurs de renvoyer les mêmes notifications.
completeSignup POST  /enterprises/completeSignup Finalise le processus d'inscription, en spécifiant le jeton d'achèvement et le jeton d'entreprise. Cette requête ne doit pas être appelée plusieurs fois pour un jeton d'entreprise donné.
createWebToken POST  /enterprises/enterpriseId/createWebToken Renvoie un jeton unique pour accéder à une interface utilisateur intégrable. Pour générer une interface utilisateur Web, transmettez le jeton généré à l'API JavaScript Google Play d'entreprise. Chaque jeton ne peut être utilisé que pour démarrer une seule session d'interface utilisateur. Pour en savoir plus, consultez la documentation de l'API JavaScript.
enregistrer POST  /enterprises/enroll Enregistre une entreprise auprès de l'EMM appelant.

Paramètres de requête requis: token

generateSignupUrl POST  /enterprises/signupUrl Génère une URL d'inscription.
get GET  /enterprises/enterpriseId Récupère le nom et le domaine d'une entreprise.
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount Renvoie un compte de service et des identifiants. Le compte de service peut être lié à l'entreprise en appelant setAccount. Le compte de service est propre à cette entreprise et à cette solution EMM. Il sera supprimé si l'entreprise est dissociée. Les identifiants contiennent des données de clé privée et ne sont pas stockés côté serveur.

Cette méthode ne peut être appelée qu'après avoir appelé Enterprises.Enrollment ou Enterprises.CompleteSignup, et avant Enterprises.SetAccount. Dans les autres cas, elle renvoie une erreur.

Les appels suivants après le premier généreront un nouvel ensemble unique d'identifiants et invalideront les identifiants générés précédemment.

Une fois que le compte de service est lié à l'entreprise, vous pouvez le gérer à l'aide de la ressource serviceAccountKeys.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Affiche la mise en page de la boutique pour l'entreprise. Si la mise en page du magasin n'a pas été définie, le type de mise en page "de base" est renvoyé, et aucune page d'accueil n'est définie.
liste GET  /enterprises Recherche une entreprise par nom de domaine. Cette option n'est disponible que pour les entreprises créées via le flux de création initié par Google. La recherche de l'ID n'est pas nécessaire pour les entreprises créées via le flux initié par l'EMM, car celui-ci apprend l'ID de l'entreprise dans le rappel spécifié dans l'appel Enterprises.generateSignupUrl.

Paramètres de requête requis: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Récupère et renvoie un ensemble de notifications pour les entreprises associées au compte de service authentifié pour la requête. L'ensemble de notifications peut être vide si aucune notification n'est en attente.
Un ensemble de notifications renvoyé doit être confirmé dans un délai de 20 secondes en appelant Enterprises.ConfirmNotificationSet, sauf si l'ensemble de notifications est vide.
Les notifications qui ne sont pas confirmées dans les 20 secondes seront à nouveau incluses dans la réponse à une autre requête PullNotificationSet. Celles qui ne sont jamais confirmées seront à terme supprimées conformément à la stratégie système Pub/Sub de Google Cloud Platform.
Plusieurs requêtes peuvent être effectuées simultanément pour récupérer des notifications. Dans ce cas, les notifications en attente (le cas échéant) seront réparties entre chaque appelant, le cas échéant.
Si aucune notification n'est présente, une liste de notifications vide est renvoyée. Les requêtes suivantes peuvent renvoyer plus de notifications une fois qu'elles sont disponibles.
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification Envoie une notification de test pour valider l'intégration EMM avec le service Google Cloud Pub/Sub pour cette entreprise.
setAccount PUT  /enterprises/enterpriseId/account Définit le compte qui sera utilisé pour s'authentifier auprès de l'API en tant qu'entreprise.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Définit la mise en page du magasin pour l'entreprise. Par défaut, storeLayoutType est défini sur "basic" et la mise en page de base du store est activée. La mise en page de base ne contient que les applications approuvées par l'administrateur et qui ont été ajoutées à l'ensemble de produits disponible pour un utilisateur (à l'aide de l'appel setAvailableProductSet). Les applications sur la page sont triées par ordre de valeur d'ID produit. Si vous créez une mise en page de magasin personnalisée (en définissant storeLayoutType sur "custom" et en définissant une page d'accueil), la mise en page de base du magasin est désactivée.
se désinscrire POST  /enterprises/enterpriseId/unenroll Désinscrit une entreprise de l'EMM appelant.

Droits

Pour en savoir plus sur la ressource Entitlements, consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Supprime le droit d'accès d'une application à une application.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Récupère les détails d'un droit d'accès.
liste GET  /enterprises/enterpriseId/users/userId/entitlements Répertorie tous les droits d'accès de l'utilisateur spécifié. Seul l'ID est défini.
mise à jour PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Ajoute ou met à jour un droit d'accès à une application pour un utilisateur.

Licences de groupe

Pour en savoir plus sur la ressource Grouplicenses, consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId Récupère les détails de la licence de groupe d'une entreprise pour un produit.
liste GET  /enterprises/enterpriseId/groupLicenses Récupère les ID de tous les produits pour lesquels l'entreprise dispose d'une licence de groupe.

Utilisateurs de licences de groupe

Pour en savoir plus sur la ressource "Grouplicenseusers", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
liste GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Récupère les ID des utilisateurs auxquels des droits d'accès ont été accordés dans le cadre de la licence.

Installations

Pour en savoir plus sur la ressource "Installs" (Installations), consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Demandes de suppression d'une application d'un appareil Un appel à get ou list continuera d'afficher l'application comme installée sur l'appareil jusqu'à sa suppression effective.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Récupère les détails de l'installation d'une application sur un appareil.
liste GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs Récupère les détails de toutes les applications installées sur l'appareil spécifié.
mise à jour PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Demande d'installer la dernière version d'une application sur un appareil. Si l'application est déjà installée, elle est mise à jour vers la dernière version si nécessaire.

Configurations gérées pour l'appareil

Pour en savoir plus sur la ressource "Managedconfigurationsfordevice", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Supprime une configuration gérée par appareil pour une application pour l'appareil spécifié.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Récupère les détails d'une configuration gérée par appareil.
liste GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice Répertorie toutes les configurations gérées par appareil pour l'appareil spécifié. Seul l'ID est défini.
mise à jour PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Ajoute ou met à jour une configuration gérée par appareil dans une application pour l'appareil spécifié.

Configurations gérées pour l'utilisateur

Pour en savoir plus sur la ressource "Managedconfigurationsforuser", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Supprime une configuration gérée par utilisateur pour une application pour l'utilisateur spécifié.
get GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Récupère les détails d'une configuration gérée par utilisateur pour une application pour l'utilisateur spécifié.
liste GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser Répertorie toutes les configurations gérées par utilisateur pour l'utilisateur spécifié. Seul l'ID est défini.
mise à jour PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Ajoute ou met à jour les paramètres de configuration gérée d'une application pour l'utilisateur spécifié. Si vous êtes compatible avec l'iFrame de configurations gérées, vous pouvez appliquer des configurations gérées à un utilisateur en spécifiant un mcmId et ses variables de configuration associées (le cas échéant) dans la requête. Tous les EMM peuvent également appliquer des configurations gérées en transmettant une liste de propriétés gérées.

Managedconfigurationssettings

Pour en savoir plus sur la ressource "Managedconfigurationssettings", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
liste GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings Répertorie tous les paramètres des configurations gérées pour l'application spécifiée.

Autorisations

Pour en savoir plus sur la ressource "Autorisations", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
get GET  /permissions/permissionId Récupère les détails d'une autorisation d'application Android à afficher pour un administrateur d'entreprise.

Produits

Pour en savoir plus sur la ressource "Products", consultez la page relative aux représentations de la ressource.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
approuver POST  /enterprises/enterpriseId/products/productId/approve

Approuve le produit spécifié et les autorisations de l'application concernée, le cas échéant. Le nombre maximal de produits que vous pouvez approuver par entreprise cliente est de 1 000.

Pour découvrir comment utiliser Google Play d'entreprise pour concevoir et créer une mise en page de magasin afin de présenter les produits approuvés à vos utilisateurs, consultez Mise en page de la boutique.

generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl Génère une URL qui peut être affichée dans un iFrame pour afficher les autorisations (le cas échéant) d'un produit. Un administrateur d'entreprise doit afficher ces autorisations et les accepter au nom de son organisation afin d'approuver ce produit.

Les administrateurs doivent accepter les autorisations affichées en interagissant avec un élément d'UI distinct dans la console EMM, ce qui devrait déclencher l'utilisation de cette URL en tant que propriété approvalUrlInfo.approvalUrl dans un appel Products.approve pour approuver le produit. Cette URL ne peut être utilisée pour afficher les autorisations que pendant 1 jour.
get GET  /enterprises/enterpriseId/products/productId Récupère les informations d'un produit pour les présenter à un administrateur d'entreprise.
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema Récupère le schéma qui définit les propriétés configurables pour ce produit. Tous les produits disposent d'un schéma, mais celui-ci peut être vide si aucune configuration gérée n'a été définie. Ce schéma peut être utilisé pour renseigner une UI permettant à un administrateur de configurer le produit. Pour appliquer une configuration gérée basée sur le schéma obtenu à l'aide de cette API, consultez la page Configurations gérées via Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Récupère les autorisations d'application Android requises par cette application.
liste GET  /enterprises/enterpriseId/products Recherche les produits approuvés qui correspondent à une requête, ou tous les produits approuvés s'il n'y a pas de requête.
annuler l'approbation POST  /enterprises/enterpriseId/products/productId/unapprove Annule l'approbation du produit spécifié (et des autorisations de l'application concernée, le cas échéant)

Clés de compte de service

Pour en savoir plus sur la ressource "Serviceaccountkeys", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Supprime et invalide les identifiants spécifiés pour le compte de service associé à cette entreprise. Le compte de service appelant doit avoir été récupéré en appelant Enterprises.GetServiceAccount et doit avoir été défini comme compte de service d'entreprise en appelant Enterprises.SetAccount.
insérer POST  /enterprises/enterpriseId/serviceAccountKeys Génère de nouveaux identifiants pour le compte de service associé à cette entreprise. Le compte de service appelant doit avoir été récupéré en appelant Enterprises.GetServiceAccount et avoir été défini comme compte de service d'entreprise en appelant Enterprises.SetAccount.

Seul le type de la clé doit être renseigné dans la ressource à insérer.
liste GET  /enterprises/enterpriseId/serviceAccountKeys Répertorie tous les identifiants actifs du compte de service associé à cette entreprise. Seuls l'ID et le type de clé sont renvoyés. Le compte de service appelant doit avoir été récupéré en appelant Enterprises.GetServiceAccount et avoir été défini comme compte de service d'entreprise en appelant Enterprises.SetAccount.

Clusters de mise en page de stockage

Pour en savoir plus sur la ressource Storelayoutclusters, consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Supprime un cluster.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Récupère les détails d'un cluster.
insérer POST  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Insère un nouveau cluster dans une page.
liste GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Récupère les détails de tous les clusters de la page spécifiée.
mise à jour PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Met à jour un cluster.

Pages de mise en page de la boutique

Pour en savoir plus sur la ressource "Storelayoutpages", consultez la page sur la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId Supprime une page commerciale.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId Récupère les détails d'une page commerciale.
insérer POST  /enterprises/enterpriseId/storeLayout/pages Insère une nouvelle page commerciale.
liste GET  /enterprises/enterpriseId/storeLayout/pages Récupère les détails de toutes les pages du magasin.
mise à jour PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Met à jour le contenu d'une page commerciale.

Utilisateurs

Pour en savoir plus sur la ressource "Users", consultez la page relative aux représentations de la ressource.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/users/userId Suppression d'un utilisateur géré par un fournisseur EMM.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Génère un jeton d'authentification que le client Device Policy peut utiliser pour provisionner le compte utilisateur géré par EMM donné sur un appareil. Le jeton généré est à usage unique et expire au bout de quelques minutes.

Vous pouvez provisionner jusqu'à 10 appareils par utilisateur.

Cet appel ne fonctionne qu'avec les comptes gérés par un fournisseur EMM.
get GET  /enterprises/enterpriseId/users/userId Récupère les informations d'un utilisateur.
getAvailableProductSet GET  /enterprises/enterpriseId/users/userId/availableProductSet Récupère l'ensemble de produits auquel un utilisateur est autorisé à accéder.
insérer POST  /enterprises/enterpriseId/users Crée un utilisateur géré par EMM.

La ressource Users transmise dans le corps de la requête doit inclure accountIdentifier et accountType.

Si un utilisateur correspondant existe déjà avec le même identifiant de compte, l'utilisateur sera mis à jour avec la ressource. Dans ce cas, seul le champ displayName peut être modifié.

liste GET  /enterprises/enterpriseId/users Recherche un utilisateur à partir de son adresse e-mail principale. Cette option n'est disponible que pour les utilisateurs gérés par Google. La recherche de l'ID n'est pas nécessaire pour les utilisateurs gérés par un fournisseur EMM, car l'ID est déjà renvoyé dans le résultat de l'appel Users.insert.

Paramètres de requête requis: email

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Révoque l'accès à tous les appareils actuellement gérés par l'utilisateur. L'utilisateur ne pourra plus utiliser le Play Store d'entreprise sur ses appareils gérés.

Cet appel ne fonctionne qu'avec les comptes gérés par un fournisseur EMM.
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet Modifie l'ensemble des produits auxquels un utilisateur est autorisé à accéder (appelés produits whitelisted). Seuls les produits approuvés ou précédemment approuvés (produits dont l'approbation a été révoquée) peuvent être ajoutés à la liste blanche.
mise à jour PUT  /enterprises/enterpriseId/users/userId Met à jour les détails d'un utilisateur géré par EMM.

Cette option ne peut être utilisée qu'avec les utilisateurs gérés par un fournisseur EMM (pas avec les utilisateurs gérés par Google). Transmettez les nouveaux détails de la ressource Users dans le corps de la requête. Seul le champ displayName peut être modifié. Les autres champs doivent être non définis ou comporter la valeur actuellement active.

Applications Web

Pour en savoir plus sur la ressource "Webapps", consultez la page relative à la représentation des ressources.

Méthode Requête HTTP Description
URI relatifs à https://www.googleapis.com/androidenterprise/v1, sauf indication contraire.
supprimer DELETE  /enterprises/enterpriseId/webApps/webAppId Supprime une application Web existante.
get GET  /enterprises/enterpriseId/webApps/webAppId Récupère une application Web existante.
insérer POST  /enterprises/enterpriseId/webApps Crée une application Web pour l'entreprise.
liste GET  /enterprises/enterpriseId/webApps Récupère les détails de toutes les applications Web d'une entreprise donnée.
mise à jour PUT  /enterprises/enterpriseId/webApps/webAppId Met à jour une application Web existante.