Référence API
Documentation de référence complète pour l'API externe Nomid MDM. Trouvez des informations détaillées sur les points de terminaison, les paramètres et les formats de réponse.
URL de base
https://api.nomid.tech/emm/api/v1 Sections de la documentation
Authentification
Apprenez comment authentifier vos requêtes API en utilisant des clés API.
Actifs
Points d'accès pour lister, filtrer et récupérer les informations sur les actifs.
Stratégies
Points d'accès pour accéder aux données de stratégies et aux affectations d'appareils.
Erreurs
Comprendre les réponses d'erreur et les codes d'état.
Intégration BI
Exportations de données aplaties pour les outils de Business Intelligence.
API des commandes d'appareils
Envoyez une commande à un appareil à la fois à l'aide d'un appel REST, du verrouillage, redémarrage et messages jusqu'aux commandes destructives telles que l'effacement.
API de modifications de stratégie
Modifiez les paramètres de stratégie, les applications, les réseaux Wi-Fi et plus encore, créez une stratégie de zéro ou sous forme de copie, ou effectuez un rollback, avec une étape de révision avant que quoi que ce soit ne soit appliqué.
API de codes QR d'approvisionnement
Créer un code QR qui inscrit un nouvel appareil Android avec une stratégie, avec son propre jeton d'inscription valide pendant 24 heures.
API d'envoi d'APK
Publiez des versions d'APK signées dans la bibliothèque de votre entreprise depuis un pipeline CI, avec une clé d'API limitée à l'entreprise.
API des applications de la bibliothèque
Lisez et gérez les applications de la bibliothèque de l'entreprise, les versions d'APK, les icônes, les catégories et les tracks avec une clé d'API limitée à l'entreprise.
API Sessions d'utilisateurs d'appareils
Signalez les connexions et déconnexions des utilisateurs connectés par votre propre application sur un appareil géré, et consultez qui a utilisé quel appareil et à quel moment.
Tous les points d'accès
| Méthode | Point d'accès | Description |
|---|---|---|
| GET | /assets | Lister tous les actifs avec pagination et filtrage |
| GET | /assets/count | Obtenir le nombre total d'actifs |
| GET | /assets/{id} | Obtenir les détails d'un actif spécifique |
| GET | /policies | Lister toutes les stratégies |
| GET | /policies/{pathName} | Obtenir les détails d'une stratégie spécifique |
| GET | /assets/summary | Obtenir les chiffres agrégés de la flotte : totaux, ventilation par état et résumé de la posture de sécurité |
| GET | /assets/{assetId}/commands | Lister les commandes les plus récentes envoyées à un appareil |
| POST | /assets/{assetId}/commands/lock | Verrouiller l'écran de l'appareil immédiatement. Appareils Android Management uniquement. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/lost-mode | Verrouiller l'appareil et afficher un message, avec des coordonnées facultatives, sur son écran de verrouillage. Appareils Android Management uniquement. |
| POST | /assets/{assetId}/commands/found | Mettre fin au mode perdu. Rien ne se produit et aucune erreur n'est renvoyée si l'appareil n'était pas en mode perdu. Appareils Android Management uniquement. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/message | Afficher une notification push en texte brut sur l'appareil. |
| POST | /assets/{assetId}/commands/status-report | Demander à l'appareil d'envoyer un rapport d'état actualisé maintenant. Le rapport arrive plus tard : lisez-le avec GET /assets/ASSET_ID. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/location-update | Demander à l'appareil de signaler sa position actuelle maintenant. La position arrive plus tard : lisez-la avec GET /assets/ASSET_ID. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/sync-policy | Renvoyer la stratégie actuelle à l'appareil. Appareils gérés par l'agent Nomid (AOSP) uniquement : les appareils Android Management reçoivent automatiquement les modifications de stratégie et renvoient 409. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/reboot | Redémarrer l'appareil maintenant. La personne qui l'utilise est interrompue, et le travail non enregistré peut être perdu. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/shutdown | Éteindre l'appareil maintenant. Il ne peut pas être rallumé à distance. Appareils gérés par l'agent Nomid (AOSP) uniquement. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/launch-app | Ouvrir une application installée sur l'appareil par son nom de package. Appareils gérés par l'agent Nomid (AOSP) uniquement. |
| POST | /assets/{assetId}/commands/clear-app-data | Supprimer toutes les données des applications indiquées (comptes, paramètres et fichiers), comme si elles venaient d'être installées. Cette action est irréversible. Appareils Android Management uniquement. |
| POST | /assets/{assetId}/commands/change-policy | Transférer l'appareil vers une autre stratégie de l'entreprise. L'appareil applique les applications, restrictions et paramètres de la nouvelle stratégie, et tout élément présent uniquement dans la stratégie actuelle est supprimé. Nécessite également POLICIES_READ. |
| POST | /assets/{assetId}/commands/wipe | Retirer l'appareil de la gestion et effacer ses données gérées. Un appareil appartenant à l'entreprise est réinitialisé aux paramètres d'usine : toutes les applications et toutes les données qu'il contient sont effacées. Sur un appareil personnel doté d'un profil professionnel, seuls le profil professionnel ainsi que ses applications et données sont supprimés ; les applications et données personnelles sont conservées. Irréversible. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/reset-screen-lock | Supprimer le verrouillage de l'écran de l'appareil (code PIN, schéma ou mot de passe), afin qu'il puisse être déverrouillé sans celui-ci. Appareils Android Management uniquement. Aucun corps de requête. |
| POST | /assets/{assetId}/commands/change-screen-lock-password | Définir un nouveau mot de passe de verrouillage de l'écran. L'appareil se verrouille, et seul le nouveau mot de passe permet de le déverrouiller. Appareils Android Management uniquement. |
| POST | /assets/{assetId}/commands/uninstall-apps | Désinstaller de l'appareil les applications indiquées et toutes leurs données. Appareils gérés par l'agent Nomid (AOSP), version 4.5.20 ou ultérieure, uniquement : les appareils Android Management répondent 409, et un agent plus ancien enregistre la commande comme échouée. L'appareil l'exécute lors de sa prochaine connexion, même plusieurs jours plus tard. Une application que la stratégie de l'appareil installe encore revient à la prochaine synchronisation de la stratégie ; pour la tenir à l'écart, bloquez-la dans la stratégie. |
| POST | /assets/{assetId}/commands/relinquish-ownership | Céder un appareil appartenant à l'entreprise à son utilisateur. Le profil professionnel et ses données sont supprimés, et l'appareil n'est plus géré. Irréversible. Aucun corps de requête. |
| GET | /policies/{policyId}/settings | Les paramètres modifiables de la stratégie, chacun avec sa valeur actuelle, ses valeurs autorisées, son groupe et l'indication s'il est signalé comme à fort impact, ce qui rend sa modification HIGH dès 1 appareil. Renvoie aussi la version de la stratégie, deviceCount, si la stratégie est modifiable, et ses applications, chacune avec packageName, name, source, installType et managedByNomid, qui vaut true pour les applications qui ne peuvent pas être modifiées ici. |
| GET | /policies/{policyId}/document | La configuration complète de la stratégie au format JSON dans value, ou seulement la partie située au niveau de path, un pointeur JSON tel que /openNetworkConfigurations. Une application est ciblée par son nom de package, comme dans /apps/com.example.app. Les secrets sont renvoyés sous forme de marqueur, un objet avec redacted défini sur true, tout comme chaque valeur de la configuration gérée d'une application. Sans path, les applications sont résumées avec packageName, name, source, installType et managedConfigurationKeys. Renvoie également policyId, displayName, version, deviceCount, editable et lockedFields, les champs refusés par le point de terminaison d'édition, chacun avec son motif. Une partie de plus de 30000 caractères renvoie fieldSizes au lieu de value : lisez un chemin plus restreint. Renvoie 422 lorsque path désigne une application que la stratégie ne possède pas. |
| GET | /policies/{policyId}/revisions | Les révisions enregistrées de la stratégie, de la plus récente à la plus ancienne, avec la date et l'auteur de chaque enregistrement. limit est facultatif, de 1 à 100, valeur par défaut 20. |
| GET | /policy-proposals/{proposalId} | Une proposition effectuée par cette clé, avec sa liste de modifications et son statut : PENDING, EXECUTING, SUCCEEDED, FAILED, UNCONFIRMED ou EXPIRED. |
| POST | /policies/{policyId}/changes | Proposer des modifications de paramètres pour une stratégie existante. Renvoie 201 avec la proposition. |
| POST | /policies/{policyId}/app-changes | Proposez d'ajouter des applications à une stratégie existante, de les supprimer ou de modifier leur mode d'installation. Renvoie 201 avec la proposition. |
| POST | /policies/{policyId}/edits | Proposez des modifications à n'importe quelle partie modifiable d'une stratégie existante, sous forme d'éditions par pointeur JSON de son document. Renvoie 201 avec la proposition. |
| POST | /policies/{policyId}/home-screen | Propose une modification de l'écran d'accueil de la stratégie : l'écran d'accueil de l'appareil lui-même, le launcher de Nomid ou Nomid Kiosk, avec le dock du launcher et les applications qu'il affiche. Renvoie 201 avec la proposition. |
| POST | /policies/{policyId}/details | Propose une modification de la description, des étiquettes ou du groupe de la stratégie. Les appareils ne sont pas concernés, l'impact n'est donc jamais HIGH. Renvoie 201 avec la proposition. |
| POST | /policies | Proposez une nouvelle stratégie, avec des modifications facultatives de paramètres. Avec fromPolicyId, il s'agit d'une copie de cette stratégie, et sans modifications, d'un doublon. Sans fromPolicyId, elle part des valeurs par défaut de Nomid. Renvoie 201 avec la proposition. |
| POST | /policies/{policyId}/rollbacks | Proposer de restaurer la stratégie à une révision antérieure. Renvoie 201 avec la proposition. |
| POST | /policy-proposals/{proposalId}/apply | Appliquer une proposition en attente. Renvoie 200 avec la proposition et son résultat : policyId, displayName, version et un lien vers le portail. |
| POST | /policies/{policyId}/provisioning-qr-codes | Créer un code QR d'approvisionnement pour une stratégie, avec un nouveau jeton d'inscription |
| POST | /library/apps/uploads/check | Vérifiez l'éligibilité, le contenu en double et une éventuelle session reprenable existante. Un doublon est purement informatif. |
| POST | /library/apps/uploads/start | Démarrez un envoi et recevez sessionId, partSize et expiresAt. |
| POST | /library/apps/uploads/parts/sign | Obtenez une URL PUT S3 directe de courte durée et les requiredHeaders pour une partie. |
| GET | /library/apps/uploads/parts/{sessionId} | Listez les parties déjà envoyées et réutilisables, avec leurs ETag exacts, pour la même session. |
| POST | /library/apps/uploads/complete | Soumettez la liste ordonnée des parties et, en option, les tracks pour assembler et traiter l'APK. |
| GET | /library/apps/uploads/status/{sessionId} | Interrogez la session jusqu'à ce que status soit completed ou failed. |
| DELETE | /library/apps/uploads/abort/{sessionId} | Annulez une session inachevée ; les sessions en cours de traitement ou terminées ne peuvent pas être annulées. |
| GET | /library/apps/{packageName}/versions/{versionCode}/check-report | Lisez le dernier rapport de vérification d'envoi d'une version. Il nécessite le packageName et le versionCode de la version, ainsi que son environnement lorsqu'il n'est pas vide. |
| GET | /library/apps | Liste les applications visibles par pages ; includeHidden permet d'inclure les applications masquées. |
| GET | /library/apps/{packageName} | Récupère une application, y compris lorsqu'elle est masquée. |
| GET | /library/apps/{packageName}/versions | Liste les versions ; includeHidden permet d'inclure les versions masquées. |
| GET | /library/apps/{packageName}/versions/{versionCode} | Récupère une version, y compris lorsqu'elle est masquée. Indiquez son environment lorsqu'il n'est pas vide. |
| PATCH | /library/apps/{packageName}/display-name | Définit un nom d'affichage ou le réinitialise au nom de l'APK. |
| PATCH | /library/apps/{packageName}/categories | Remplace les libellés de catégorie de l'application. |
| POST | /library/apps/{packageName}/icon | Envoie une icône en multipart form-data via le champ file. |
| DELETE | /library/apps/{packageName}/icon | Supprime l'icône personnalisée. |
| DELETE | /library/apps/{packageName} | Masque une application existante ; renvoie 204 et ne la supprime pas physiquement. |
| POST | /library/apps/{packageName}/publish | Restaure une application de manière idempotente ; renvoie l'application. |
| DELETE | /library/apps/{packageName}/versions/{versionCode} | Masque une version existante ; renvoie 204. S'il s'agit de la dernière version publiée, l'application devient masquée tandis que cette version reste publiée afin de permettre la restauration. Indiquez son environment lorsqu'il n'est pas vide. |
| POST | /library/apps/{packageName}/versions/{versionCode}/publish | Restaure une version et, si nécessaire, son application. Indiquez son environment lorsqu'il n'est pas vide. |
| GET | /library/apps/{packageName}/tracks | Liste la dernière version publiée de chaque track d'une application publiée. À codes de version égaux, l'environment le plus élevé dans l'ordre lexicographique l'emporte. |
| PUT | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Affecte une version publiée à un track ; renvoie l'affectation. Indiquez son environment lorsqu'il n'est pas vide. |
| DELETE | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Supprime l'affectation d'un track ; renvoie 204. Indiquez son environment lorsqu'il n'est pas vide. |
| GET | /device-user-logins | Lister les sessions d'utilisateurs d'appareils, de la plus récente à la plus ancienne, avec des filtres facultatifs |
| POST | /device-user-logins | Signaler qu'un utilisateur authentifié par votre système s'est connecté sur un appareil ; renvoie 201 avec la session |
| POST | /device-user-logins/logout | Signaler une déconnexion, par loginId ou par appareil et utilisateur ; renvoie les sessions concernées |
Types de contenu
Toutes les requêtes et réponses utilisent le format JSON. Définissez l'en-tête Content-Type en conséquence.
Content-Type: application/json