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. Enrollmenttokens
  3. Entreprises
  4. Droits d'accès
  5. Licences de groupe
  6. Grouplicenseusers
  7. Installations
  8. Managedconfigurationsfordevice
  9. Managedconfigurationsforuser
  10. Managedconfigurationssettings
  11. Autorisations
  12. Produits
  13. Serviceaccountkeys
  14. Storelayoutclusters
  15. Storelayoutpages
  16. Utilisateurs
  17. Applications Web

Appareils

Pour en savoir plus sur la ressource "Devices", 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 des applications sur l'appareil depuis la dernière génération du 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 Récupère l'état d'accès d'un appareil aux services Google (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 fonctionnalité n'est disponible que pour les utilisateurs gérés par Google.
liste GET  /enterprises/enterpriseId/users/userId/devices Récupère les ID de tous les appareils d'un utilisateur.
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state Indique 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 fonctionnalité n'est disponible que pour les utilisateurs gérés par Google.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Met à jour les règles relatives aux appareils.

Pour vous assurer que le règlement est correctement appliqué, 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 Restreindre les comptes dans Google Play.

Enrollmenttokens

Pour plus de détails sur la ressource "Enrollmenttokens", 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
create POST  /enterprises/enterpriseId/enrollmentTokens Crée un jeton d'inscription pour l'entreprise. Cette méthode fait partie d'EnrollmentTokensService.

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 Confirme les notifications reçues de 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 de finalisation et le jeton d'entreprise. Cette requête ne doit pas être appelée plusieurs fois pour un jeton Enterprise donné.
createWebToken POST  /enterprises/enterpriseId/createWebToken Renvoie un jeton unique permettant d'accéder à une UI intégrable. Pour générer une interface utilisateur Web, transmettez le jeton généré à l'API JavaScript Managed Google Play. Chaque jeton ne peut être utilisé que pour démarrer une seule session d'UI. Pour en savoir plus, consultez la documentation de l'API JavaScript.
enroll POST  /enterprises/enroll Inscrit une entreprise auprès de l'EMM appelant.

Paramètres de requête requis : token

generateEnterpriseUpgradeUrl POST  /enterprises/enterpriseId/generateEnterpriseUpgradeUrl Génère une URL de mise à niveau d'entreprise pour mettre à niveau un compte d'entreprise Google Play Accounts existant vers un domaine Google géré. Pour en savoir plus, consultez le guide de mise à niveau d'une entreprise.
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 associé à l'entreprise en appelant setAccount. Le compte de service est propre à cette entreprise et à cet 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 l'appel de Enterprises.Enroll ou Enterprises.CompleteSignup, et avant Enterprises.SetAccount. Dans le cas contraire, elle renvoie une erreur.

Les appels suivants génèrent un nouvel ensemble unique d'identifiants et invalident ceux générés précédemment.

Une fois le compte de service associé à l'entreprise, il peut être géré à l'aide de la ressource serviceAccountKeys.

.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Renvoie la mise en page du magasin pour l'entreprise. Si la mise en page du magasin n'a pas été définie, la fonction renvoie "basic" comme type de mise en page du magasin et aucune page d'accueil.
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 l'EMM apprend l'ID d'entreprise dans le rappel spécifié dans l'appel Enterprises.generateSignupUrl.

Paramètres de requête requis : domain

pullNotificationSet POST  /enterprises/pullNotificationSet Extrait 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 les 20 secondes en appelant Enterprises.AcknowledgeNotificationSet, sauf si l'ensemble de notifications est vide.
Les notifications qui ne sont pas confirmées dans les 20 secondes seront de nouveau incluses dans la réponse à une autre requête PullNotificationSet. Celles qui ne sont jamais confirmées seront finalement supprimées conformément au règlement du système Google Cloud Platform Pub/Sub.
Plusieurs requêtes peuvent être effectuées simultanément pour récupérer les notifications. Dans ce cas, les notifications en attente (le cas échéant) seront réparties entre chaque appelant, s'il y en a.
Si aucune notification n'est présente, une liste de notifications vide est renvoyée. Les demandes ultérieures 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 de l'EMM au service Google Cloud Pub/Sub pour cette entreprise.
setAccount PUT  /enterprises/enterpriseId/account Définit le compte qui sera utilisé pour l'authentification 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 magasin 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 disponibles pour un utilisateur (à l'aide de l'appel setAvailableProductSet). Les applications sur la page sont triées par ordre de valeur de leur ID de produit. Si vous créez une mise en page personnalisée pour votre magasin (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'un utilisateur à 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 Liste tous les droits d'accès pour l'utilisateur spécifié. Seul l'ID est défini.
update 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 plus de détails 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.

Grouplicenseusers

Pour plus de détails 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 en vertu de la licence.

Installations

Pour plus de détails sur la ressource "Installs", 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 affichera toujours l'application comme installée sur l'appareil jusqu'à ce qu'elle soit réellement supprimée.
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é.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Demandes d'installation de 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.

Managedconfigurationsfordevice

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 sur 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 Liste toutes les configurations gérées par appareil pour l'appareil spécifié. Seul l'ID est défini.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Ajoute ou met à jour une configuration gérée par appareil pour une application pour l'appareil spécifié.

Managedconfigurationsforuser

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 Liste toutes les configurations gérées par utilisateur pour l'utilisateur spécifié. Seul l'ID est défini.
update 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 Liste tous les paramètres de configuration gérée pour l'application spécifiée.

Autorisations

Pour plus de détails sur la ressource "Permissions", 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 pour les afficher à un administrateur d'entreprise.

Produits

Pour en savoir plus sur la ressource "Products", 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
approve POST  /enterprises/enterpriseId/products/productId/approve

Approuve le produit spécifié et les autorisations d'application associées, le cas échéant. Le nombre maximal de produits que vous pouvez approuver par client Enterprise est de 1 000.

Pour savoir comment utiliser Google Play d'entreprise afin de concevoir et de créer une mise en page du Play Store pour afficher les produits approuvés à vos utilisateurs, consultez Concevoir la mise en page du Play Store.

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 consulter ces autorisations et les accepter au nom de son organisation pour approuver ce produit.

Les administrateurs doivent accepter les autorisations affichées en interagissant avec un élément d'interface utilisateur 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 que pour afficher les autorisations pendant un jour maximum.
get GET  /enterprises/enterpriseId/products/productId Récupère les détails d'un produit pour les afficher à 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 ont 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 remplir 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 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 Trouve les produits approuvés qui correspondent à une requête, ou tous les produits approuvés s'il n'y a pas de requête.
désapprouver POST  /enterprises/enterpriseId/products/productId/unapprove Annule l'approbation du produit spécifié (et des autorisations d'application associées, le cas échéant).

Serviceaccountkeys

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 de l'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 doit avoir été défini comme compte de service de l'entreprise en appelant Enterprises.SetAccount.

Seul le type de clé doit être renseigné dans la ressource à insérer.
liste GET  /enterprises/enterpriseId/serviceAccountKeys Liste 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 doit avoir été défini comme compte de service de l'entreprise en appelant Enterprises.SetAccount.

Storelayoutclusters

Pour plus de détails 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 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.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Met à jour un cluster.

Storelayoutpages

Pour plus de détails sur la ressource "Storelayoutpages", 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 Supprime une page de magasin.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId Récupère les détails d'une page de magasin.
insérer POST  /enterprises/enterpriseId/storeLayout/pages Insère une nouvelle page de magasin.
liste GET  /enterprises/enterpriseId/storeLayout/pages Récupère les détails de toutes les pages de la boutique.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Met à jour le contenu d'une page de boutique.

Utilisateurs

Pour en savoir plus sur la ressource "Users", 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 Un utilisateur géré par un EMM a été supprimé.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Génère un jeton d'authentification que le client de règles relatives aux appareils peut utiliser pour provisionner le compte utilisateur géré par l'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 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 des produits auxquels un utilisateur est autorisé à accéder.
insérer POST  /enterprises/enterpriseId/users Crée un utilisateur géré par l'EMM.

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

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

liste GET  /enterprises/enterpriseId/users Recherche un utilisateur par son adresse e-mail principale. Cette fonctionnalité 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 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 provisionnés pour l'utilisateur. L'utilisateur ne pourra plus utiliser le Play Store géré sur aucun de ses appareils gérés.

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

Ne peut être utilisé qu'avec des utilisateurs gérés par un EMM (et non des utilisateurs gérés par Google). Transmettez les nouvelles informations dans la ressource Users du corps de la requête. Seul le champ displayName peut être modifié. Les autres champs doivent être non définis ou avoir la valeur actuellement active.

Applications Web

Pour plus de détails 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 pour une entreprise donnée.
update PUT  /enterprises/enterpriseId/webApps/webAppId Met à jour une application Web existante.