API-Referenz
Vollständige Referenzdokumentation für die Nomid MDM External API. Finden Sie detaillierte Informationen zu Endpunkten, Parametern und Antwortformaten.
Basis-URL
https://api.nomid.tech/emm/api/v1 Dokumentationsabschnitte
Authentifizierung
Erfahren Sie, wie Sie Ihre API-Anfragen mit API-Schlüsseln authentifizieren.
Assets
Endpunkte zum Auflisten, Filtern und Abrufen von Asset-Informationen.
Richtlinien
Endpunkte für den Zugriff auf Richtliniendaten und Gerätezuweisungen.
Fehler
Fehlerantworten und Statuscodes verstehen.
BI-Integration
Abgeflachte Datenexporte für Business-Intelligence-Tools.
Gerätebefehle-API
Senden Sie mit einem REST-Aufruf einen Befehl an jeweils ein Gerät – von Sperren, Neustart und Nachrichten bis hin zu destruktiven Befehlen wie dem Löschen.
API für Richtlinienänderungen
Richtlinieneinstellungen, Apps, WLAN-Netzwerke und mehr ändern, eine Richtlinie von Grund auf neu oder als Kopie erstellen oder eine Richtlinie zurücksetzen – mit einem Überprüfungsschritt, bevor Änderungen angewendet werden.
Bereitstellungs-QR-Codes-API
Erstellen Sie einen QR-Code, der ein neues Android-Gerät mit einer Richtlinie registriert, mit einem eigenen Registrierungstoken, das für 24 Stunden gültig ist.
APK-Upload-API
Veröffentlichen Sie signierte APK-Releases aus einer CI-Pipeline mit einem unternehmensbezogenen API-Schlüssel in der Bibliothek Ihres Unternehmens.
Bibliotheks-Apps-API
Apps der Unternehmensbibliothek, APK-Releases, Symbole, Kategorien und Tracks mit einem unternehmensbezogenen API-Schlüssel lesen und verwalten.
Device-User-Sitzungs-API
Melden Sie die An- und Abmeldungen von Benutzern, die von Ihrer eigenen App auf einem verwalteten Gerät angemeldet werden, und lesen Sie aus, wer welches Gerät wann verwendet hat.
Alle Endpunkte
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /assets | Alle Assets mit Paginierung und Filterung auflisten |
| GET | /assets/count | Gesamtzahl der Assets abrufen |
| GET | /assets/{id} | Details zu einem bestimmten Asset abrufen |
| GET | /policies | Alle Richtlinien auflisten |
| GET | /policies/{pathName} | Details zu einer bestimmten Richtlinie abrufen |
| GET | /assets/summary | Aggregierte Flottenzahlen abrufen: Gesamtzahlen, eine Statusaufschlüsselung und eine Zusammenfassung des Sicherheitsstatus |
| GET | /assets/{assetId}/commands | Die neuesten an ein Gerät gesendeten Befehle auflisten |
| POST | /assets/{assetId}/commands/lock | Den Gerätebildschirm sofort sperren. Nur Geräte mit Android Management. Kein Request-Body. |
| POST | /assets/{assetId}/commands/lost-mode | Das Gerät sperren und eine Nachricht mit optionalen Kontaktdaten auf dessen Sperrbildschirm anzeigen. Nur Geräte mit Android Management. |
| POST | /assets/{assetId}/commands/found | Modus für verlorene Geräte beenden. Wenn sich das Gerät nicht im Modus für verlorene Geräte befand, geschieht nichts und es wird kein Fehler zurückgegeben. Nur Geräte mit Android Management. Kein Request-Body. |
| POST | /assets/{assetId}/commands/message | Eine Nur-Text-Push-Benachrichtigung auf dem Gerät anzeigen. |
| POST | /assets/{assetId}/commands/status-report | Fordern Sie das Gerät auf, jetzt einen aktuellen Statusbericht zu senden. Der Bericht trifft später ein: Lesen Sie ihn mit GET /assets/ASSET_ID aus. Kein Request-Body. |
| POST | /assets/{assetId}/commands/location-update | Fordern Sie das Gerät auf, seinen aktuellen Standort jetzt zu melden. Der Standort trifft später ein: Lesen Sie ihn mit GET /assets/ASSET_ID aus. Kein Request-Body. |
| POST | /assets/{assetId}/commands/sync-policy | Senden Sie dem Gerät seine aktuelle Richtlinie erneut. Nur für Geräte, die vom Nomid-Agenten (AOSP) verwaltet werden: Android Management-Geräte erhalten Richtlinienänderungen automatisch und antworten mit 409. Kein Request-Body. |
| POST | /assets/{assetId}/commands/reboot | Starten Sie das Gerät jetzt neu. Die Person, die es gerade verwendet, wird unterbrochen und ungespeicherte Arbeit kann verloren gehen. Kein Request-Body. |
| POST | /assets/{assetId}/commands/shutdown | Schalten Sie das Gerät jetzt aus. Es kann nicht aus der Ferne wieder eingeschaltet werden. Nur für Geräte, die vom Nomid-Agenten (AOSP) verwaltet werden. Kein Request-Body. |
| POST | /assets/{assetId}/commands/launch-app | Öffnen Sie eine installierte App auf dem Gerät anhand des Paketnamens. Nur für Geräte, die vom Nomid-Agenten (AOSP) verwaltet werden. |
| POST | /assets/{assetId}/commands/clear-app-data | Löschen Sie alle Daten der angegebenen Apps (Konten, Einstellungen und Dateien), als wären sie gerade erst installiert worden. Dies kann nicht rückgängig gemacht werden. Nur für Android Management-Geräte. |
| POST | /assets/{assetId}/commands/change-policy | Verschieben Sie das Gerät in eine andere Richtlinie des Unternehmens. Das Gerät wendet die Apps, Einschränkungen und Einstellungen der neuen Richtlinie an, und alles, was nur in der aktuellen Richtlinie enthalten war, wird entfernt. Erfordert außerdem POLICIES_READ. |
| POST | /assets/{assetId}/commands/wipe | Entfernen Sie das Gerät aus der Verwaltung und löschen Sie dessen verwaltete Daten. Ein unternehmenseigenes Gerät wird auf die Werkseinstellungen zurückgesetzt: Jede App und alle Daten darauf werden gelöscht. Bei einem Gerät in Privatbesitz mit einem Arbeitsprofil werden nur das Arbeitsprofil und dessen Apps und Daten entfernt; private Apps und Daten bleiben erhalten. Nicht umkehrbar. Kein Request-Body. |
| POST | /assets/{assetId}/commands/reset-screen-lock | Entfernen Sie die Bildschirmsperre des Geräts (PIN, Muster oder Passwort), sodass es ohne Sperre entsperrt werden kann. Nur für Android Management-Geräte. Kein Request-Body. |
| POST | /assets/{assetId}/commands/change-screen-lock-password | Legen Sie ein neues Passwort für die Bildschirmsperre fest. Das Gerät sperrt sich und kann nur mit dem neuen Passwort entsperrt werden. Nur für Android Management-Geräte. |
| POST | /assets/{assetId}/commands/uninstall-apps | Deinstallieren Sie die angegebenen Apps und alle ihre Daten vom Gerät. Nur für Geräte, die vom Nomid-Agent (AOSP) ab Version 4.5.20 verwaltet werden: Android Management-Geräte antworten mit 409, und ein älterer Agent erfasst den Befehl als fehlgeschlagen. Das Gerät führt ihn aus, wenn es sich das nächste Mal meldet, auch erst Tage später. Eine App, die die Richtlinie des Geräts weiterhin installiert, kommt bei der nächsten Richtliniensynchronisierung zurück. Blockieren Sie sie in der Richtlinie, damit sie entfernt bleibt. |
| POST | /assets/{assetId}/commands/relinquish-ownership | Geben Sie ein unternehmenseigenes Gerät für seinen Benutzer frei. Das Arbeitsprofil und dessen Daten werden entfernt und das Gerät wird nicht mehr verwaltet. Nicht umkehrbar. Kein Request-Body. |
| GET | /policies/{policyId}/settings | Die bearbeitbaren Einstellungen der Richtlinie, jeweils mit aktuellem Wert, zulässigen Werten, Gruppe und der Angabe, ob sie als Einstellung mit hoher Auswirkung markiert ist, wodurch eine Änderung ab 1 Gerät HIGH ist. Außerdem werden die Version der Richtlinie, deviceCount, die Angabe, ob die Richtlinie bearbeitbar ist, und ihre Apps zurückgegeben, jeweils mit packageName, name, source, installType und managedByNomid, das bei den Apps true ist, die hier nicht geändert werden können. |
| GET | /policies/{policyId}/document | Die vollständige Konfiguration der Richtlinie als JSON in value oder nur der Teil unter path, einem JSON-Pointer wie /openNetworkConfigurations. Eine App wird über ihren Paketnamen adressiert, wie etwa /apps/com.example.app. Geheimnisse (Secrets) werden als Markierung zurückgegeben, ein Objekt mit auf true gesetztem redacted, ebenso wie jeder Wert der verwalteten Konfiguration einer App. Ohne path werden Apps mit packageName, name, source, installType und managedConfigurationKeys zusammengefasst. Gibt außerdem policyId, displayName, version, deviceCount, editable und lockedFields zurück, die Felder, die der edits-Endpunkt ablehnt, jeweils mit Begründung. Ein Teil mit mehr als 30000 Zeichen gibt fieldSizes anstelle von value zurück: Lesen Sie einen spezifischeren Pfad. Gibt 422 zurück, wenn path eine App benennt, die in der Richtlinie nicht vorhanden ist. |
| GET | /policies/{policyId}/revisions | Die gespeicherten Revisionen der Richtlinie, die neuesten zuerst, mit Angabe darüber, wann und von wem sie jeweils gespeichert wurden. limit ist optional, von 1 bis 100, Standardwert 20. |
| GET | /policy-proposals/{proposalId} | Ein von diesem Schlüssel erstellter Vorschlag mit seiner Änderungsliste und seinem Status: PENDING, EXECUTING, SUCCEEDED, FAILED, UNCONFIRMED oder EXPIRED. |
| POST | /policies/{policyId}/changes | Schlagen Sie Einstellungsänderungen für eine bestehende Richtlinie vor. Gibt 201 mit dem Vorschlag zurück. |
| POST | /policies/{policyId}/app-changes | Vorschlagen, Apps zu einer bestehenden Richtlinie hinzuzufügen, sie zu entfernen oder ihre Installationsart zu ändern. Gibt 201 mit dem Vorschlag zurück. |
| POST | /policies/{policyId}/edits | Änderungen an beliebigen bearbeitbaren Teilen einer bestehenden Richtlinie als JSON-Pointer-Edits ihres Dokuments vorschlagen. Gibt 201 mit dem Vorschlag zurück. |
| POST | /policies/{policyId}/home-screen | Schlägt eine Änderung des Startbildschirms der Richtlinie vor: der eigene Startbildschirm des Geräts, der Launcher von Nomid oder Nomid Kiosk, mit dem Dock des Launchers und den angezeigten Apps. Gibt 201 mit dem Vorschlag zurück. |
| POST | /policies/{policyId}/details | Schlägt eine Änderung der Beschreibung, der Tags oder der Gruppe der Richtlinie vor. Geräte sind nicht betroffen, daher ist die Auswirkung nie HIGH. Gibt 201 mit dem Vorschlag zurück. |
| POST | /policies | Eine neue Richtlinie mit optionalen Einstellungsänderungen vorschlagen. Mit fromPolicyId ist sie eine Kopie dieser Richtlinie und ohne Änderungen ein Duplikat. Ohne fromPolicyId startet sie mit den Standardwerten von Nomid. Gibt 201 mit dem Vorschlag zurück. |
| POST | /policies/{policyId}/rollbacks | Schlagen Sie vor, die Richtlinie auf eine frühere Revision zurückzusetzen. Gibt 201 mit dem Vorschlag zurück. |
| POST | /policy-proposals/{proposalId}/apply | Wenden Sie einen ausstehenden Vorschlag an. Gibt 200 mit dem Vorschlag und dessen Ergebnis zurück: policyId, displayName, version und einen Portallink. |
| POST | /policies/{policyId}/provisioning-qr-codes | Erstellen Sie einen Bereitstellungs-QR-Code für eine Richtlinie mit einem neuen Registrierungstoken |
| POST | /library/apps/uploads/check | Prüft die Zulässigkeit, doppelte Inhalte und eine vorhandene fortsetzbare Sitzung. Ein Duplikat ist nur ein Hinweis. |
| POST | /library/apps/uploads/start | Startet einen Upload und liefert sessionId, partSize und expiresAt. |
| POST | /library/apps/uploads/parts/sign | Liefert eine kurzlebige direkte S3-PUT-URL und requiredHeaders für ein Teil. |
| GET | /library/apps/uploads/parts/{sessionId} | Listet wiederverwendbare hochgeladene Teile und ihre exakten ETags für dieselbe Sitzung auf. |
| POST | /library/apps/uploads/complete | Übermittelt die geordnete Teileliste und optionale tracks, um das APK zusammenzusetzen und zu verarbeiten. |
| GET | /library/apps/uploads/status/{sessionId} | Fragt die Sitzung per Polling ab, bis status completed oder failed ist. |
| DELETE | /library/apps/uploads/abort/{sessionId} | Bricht eine unfertige Sitzung ab; Sitzungen, die verarbeitet werden oder abgeschlossen sind, lassen sich nicht abbrechen. |
| GET | /library/apps/{packageName}/versions/{versionCode}/check-report | Liest den neuesten Upload-Prüfbericht eines Releases. Erforderlich sind packageName und versionCode des Releases sowie seine Umgebung, sofern sie nicht leer ist. |
| GET | /library/apps | Listet sichtbare Apps seitenweise auf; includeHidden kann ausgeblendete Apps einschließen. |
| GET | /library/apps/{packageName} | Ruft eine App ab, auch wenn sie ausgeblendet ist. |
| GET | /library/apps/{packageName}/versions | Listet Releases auf; includeHidden kann ausgeblendete Releases einschließen. |
| GET | /library/apps/{packageName}/versions/{versionCode} | Ruft ein Release ab, auch wenn es ausgeblendet ist. Geben Sie dessen environment an, wenn es nicht leer ist. |
| PATCH | /library/apps/{packageName}/display-name | Legt einen Anzeigenamen fest oder setzt ihn auf den APK-Namen zurück. |
| PATCH | /library/apps/{packageName}/categories | Ersetzt die Kategoriebezeichnungen der App. |
| POST | /library/apps/{packageName}/icon | Lädt ein Symbol als multipart form-data über das Feld file hoch. |
| DELETE | /library/apps/{packageName}/icon | Entfernt das benutzerdefinierte Symbol. |
| DELETE | /library/apps/{packageName} | Blendet eine vorhandene App aus; gibt 204 zurück und löscht sie nicht physisch. |
| POST | /library/apps/{packageName}/publish | Stellt eine App idempotent wieder her; gibt die App zurück. |
| DELETE | /library/apps/{packageName}/versions/{versionCode} | Blendet ein vorhandenes Release aus; gibt 204 zurück. Beim zuletzt veröffentlichten Release wird die App ausgeblendet, während dieses Release zur Wiederherstellung veröffentlicht bleibt. Geben Sie dessen environment an, wenn es nicht leer ist. |
| POST | /library/apps/{packageName}/versions/{versionCode}/publish | Stellt ein Release und bei Bedarf dessen App wieder her. Geben Sie dessen environment an, wenn es nicht leer ist. |
| GET | /library/apps/{packageName}/tracks | Listet für jeden Track einer veröffentlichten App das neueste veröffentlichte Release auf. Bei gleichen Versionscodes gewinnt das lexikografisch höchste environment. |
| PUT | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Weist einem Track ein veröffentlichtes Release zu; gibt die Zuweisung zurück. Geben Sie dessen environment an, wenn es nicht leer ist. |
| DELETE | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Entfernt eine Track-Zuweisung; gibt 204 zurück. Geben Sie dessen environment an, wenn es nicht leer ist. |
| GET | /device-user-logins | Device-User-Sitzungen auflisten, neueste zuerst, mit optionalen Filtern |
| POST | /device-user-logins | Melden, dass sich ein von Ihrem System authentifizierter Benutzer auf einem Gerät angemeldet hat; gibt 201 mit der Sitzung zurück |
| POST | /device-user-logins/logout | Eine Abmeldung melden, anhand der loginId oder anhand von Gerät und Benutzer; gibt die betroffenen Sitzungen zurück |
Inhaltstypen
Alle Anfragen und Antworten verwenden das JSON-Format. Setzen Sie den Content-Type-Header entsprechend.
Content-Type: application/json